GetProperty<Type> Method for LCSession
The GetProperty<Type> methods return a session property value as a specific data type. Supported data types are Boolean, Currency, Datetime, Float, Int, Numeric, and Text.
This method allows retrieval of session properties as with LCSession.GetProperty, but does not require a field object. If the property value is of a different type, data conversion will be performed.
Defined In
LCSession Class
Syntax
flag = lcSession. GetPropertyBoolean (propertyToken, default)
Set destCurrency = lcSession. GetPropertyCurrency (propertyToken)
Set destDatetime = lcSession. GetPropertyDatetime (propertyToken)
destFloat = lcSession. GetPropertyFloat (propertyToken)
destInt = lcSession. GetPropertyInt (propertyToken)
Set destNumeric = lcSession. GetPropertyNumeric (propertyToken)
Set destStream = lcSession. GetPropertyStream (propertyToken, streamFormat)
Parameters
| Parameter |
Description |
|---|---|
| propertyToken |
A token identifying the session property. See Appendix B for a list of tokens. |
| default |
(GetPropertyBoolean only) Value to be returned if the property cannot be located. Default value is FALSE. |
| streamFormat |
(GetPropertyStream only) Format that the stream is converted to before being returned. If streamFormat is zero, no conversion occurs and the stream is copied in the same format as the property value. |
Return Values
| Value |
Description |
|---|---|
| flag |
(GetPropertyBoolean only) Boolean value, either TRUE or FALSE. If the property does not exist, the default is returned. |
| dest<Type> |
Current® value for the session property. |