Common Connector Properties
The following is a list of predefined properties common to all Connectors. Use these predefined properties with the LCConnection.GetProperty and LCConnection.SetProperty methods. See "Miscellaneous" under the "LCConnection Class Methods Summary" section as well as the entry for each method.
| Property |
Name |
Description |
|---|---|---|
| LCTOKEN_NAME |
"Name" |
String. Connector name. (Read only.) This is the same as the library name given in the New method. |
| LCTOKEN_CONNECTOR_CODE |
"ConnectorCode" |
Long. Connector Virtual Code. (Read only.) |
| LCTOKEN_CONNECTION_CODE |
"ConnectionCode" |
Long. Connection Virtual Code. (Read only.) |
| 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" |
Long. 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. (Read only.) |
| LCTOKEN_IGNORE_ERROR |
"IgnoreError" |
Long. Connector status code to ignore. |
| LCTOKEN_CONNECTOR_NAME |
"ConnectorName" |
String. Use this property to specify which connector a metaconnector is filtering. This corresponds to the "Connection to use" field in the Metaconnection document in the HEI Administrator. |
| LCTOKEN_IS_CONNECTED |
"IsConnected" |
Boolean. TRUE following a successful Connect call, until Disconnect is called. FALSE otherwise. |
Properties of a connection may also be accessed by name, for example, the following line of script sets the value of database property for a Connector for DB2® to "HR."
Connection.Database = "HR"