Predefined Tokens

When you work with property tokens, keep in mind:

• Flags can be combined with LotusScript® Extensions (LC LSX) property tokens.
• The base value for a property is between 1 and 0xFFFF.

Several connector property tokens are shown as follows:

LCTOKEN_BASESTAMP -- Base timestamp value for timestamp selection; see STAMPFIELD property.

LCTOKEN_CHARACTER_SET -- Character Set indicator representing the character set used by this connector for data transfers to and from the external system. This is normally dynamically determined by the connector from the external system at run time. Often read-only, but may be assigned for some connectors. Valid values include any text stream format suffix from the supported character set appendix (such as "IBMCP932" for LCSTREAMFMT_IBMCP932.)

LCTOKEN_CONDITION -- Condition string in a syntax defined by the connector. This clause will be embedded within a selection or modification statement for Select, keyed Update, or keyed Remove operations.

LCTOKEN_CONNECTOR_CODE -- A code unique to this connector, and the same for all connections to this connector. This code is assigned dynamically, so may change for each execution of a script. This code can be used as a virtual field code to indicate special handling by any connection to this connector.

LCTOKEN_CONNECTOR_NAME -- Property representing the first sub-connector for a particular Metaconnector. Setting this property to a connector name is the same as creating a connection of that connector type and assigning it to the metaconnector.

LCTOKEN_CONNECTION_CODE -- A code unique to this connection among all connections. This code is assigned dynamically, so may change for each execution of a script. This code can be used as a virtual field code to indicate special handling by this connection only.

LCTOKEN_DATABASE -- Database string, used for connectivity.

LCTOKEN_EVENT_ERROR -- 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_FIELDNAMES -- Selection field name list, a text list (or comma or semicolon-separated list of field names in a text string) indicating fields to include in a Select method result set. By default, all fields selected are included; this property can be used to restrict that list.

LCTOKEN_IGNORE_ERROR -- Error code (LCFAIL_XXX constant) to ignore. When this error is generated, it is ignored. Set to LCSUCCESS to clear this property.

LCTOKEN_INDEX -- Index string. Used when an index name is required, such as when creating or dropping an index.

LCTOKEN_LCX_VERSION -- Version code for the connector LCX/DCX library.

LCTOKEN_MAP_NAME -- Map by name flag; set to TRUE to map fields in fieldlist to external metadata by name, and to FALSE to map by position.

LCTOKEN_MAXSTAMP -- Maximum timestamp value for timestamp selection; see the STAMPFIELD property. This property is set by the Connector during Select operations when the STAMPFIELD property is set.

LCTOKEN_METADATA -- Metadata object name. Used for reading and writing records, as well as creating, dropping, and cataloging metadata and fields.

LCTOKEN_NAME -- Library name for the connector used to create this connection.

LCTOKEN_ORDERNAMES -- Ordering field name list, a text list (or comma or semicolon-separated list of field names in a text string) indicating fields by which to order a Select method result set.

LCTOKEN_OWNER -- Owner name string to restrict Catalog method calls (excluding server and database catalogs) to only objects owned by this owner.

LCTOKEN_PASSWORD -- Password string, used for connectivity. This value is write-only, and cannot be retrieved from a connector once assigned.

LCTOKEN_PROCEDURE -- Procedure name, used by the Call method.

LCTOKEN_SCROLLABLE -- Whether to produce a scrollable result set. This property is not supported by any connectors at this time.

LCTOKEN_SERVER -- Server string, used for connectivity.

LCTOKEN_STAMPFIELD -- Name of the field containing a timestamp value (must be a datetime data type). When set before calling the Select method, the result set will be restricted to fields where the timestamp field value is between the value assigned to the BASESTAMP property and returned in the MAXSTAMP property. If BASESTAMP is not set, no minimum will be used. The Select method will determine the current time from the external server, assign that value to the MAXSTAMP property, and use that datetime as the upper boundary for selection.

LCTOKEN_TEXT_FORMAT -- See CHARACTER_SET property; this property is the numeric constant assigned to the particular character set.

LCTOKEN_USERID -- User ID string, used for connectivity.

LCTOKEN_WRITEBACK -- Writeback flag; set to TRUE before calling Select to produce a writeback result set, and before calling Update or Remove to perform a writeback operation against a writeback result set.