LCSession Class Properties Summary
All sessions have a set of predefined properties with values that can be assigned and retrieved. All properties are represented by both an integer value (called a property token) and a name.
| Property |
Description |
|---|---|
| LCSession.Status |
Status of an LCSession. Zero, or LCSUCCESS, indicates no error. A non-zero value (represented by an LCFAIL_XXX constant) indicates an error state. |
| LCSession.ConnectionPooling |
Boolean. When set to FALSE (default), subsequently created connections are not pooled when the connection object is destroyed. Setting this property to TRUE enables connection pooling. For more information about Connection Pooling, refer to the Introduction in this manual. |
HEI users can use the following additional predefined properties. See Appendix E for more information.
| Property |
Name |
Description |
|---|---|---|
| LCTOKEN_NAME |
"Name" |
String. Session name. |
| LCTOKEN_EVENT_ERROR |
"EventError" |
Long. Error code (LCFAIL_XXX constant) to treat as an event. When this error is generated, it is downgraded to an informational event. Set to LCSUCCESS to clear this property. |
| LCTOKEN_TEXT_FORMAT |
"TextFormat" |
Stream format constant for text data passed between the connector and the external system. This property is generally read-only. |
| LCTOKEN_CHARACTER_SET |
"CharacterSet" |
String. Connector character set indicator. |
| LCTOKEN_IGNORE_ERROR |
"IgnoreError" |
Long. Error code (LCFAIL_XXX constant) to ignore. When this error is generated, it is ignored. Set to LCSUCCESS to clear this property. |
Session properties may also be accessed by name. For example, the following line of script retrieves the session name for a scripted agent:
myName$ = session.Name