AddProperty Method for LCSession

This method creates a new property and assigns it a property token.

Defined In

LCSession Class

Syntax

tokenID = lcSession. AddProperty (propertyName, storageType

Parameters


Parameter	Description
propertyName	String. Name of the property to be created. The name must be unique among properties of this storage type. Using the same name as an existing property creates a new token if the storage type differs, but simply returns the previously assigned token if the storage type is the same.
storageType	Long. Optional. One of the following: LCPROPSTORE_STATIC --This value is read from or written to the activity document. LCPROPSTORE_DYNAMIC --This value will only exist during this run. LCPROPSTORE_SYSTEM -- This value is read from and written to operating system environment variables. Note: System properties are not persistent across executions.

Return Value


Value	Description
tokenID	Long. Token assigned to the property. The token is only valid for this run of the activity. The token will be a value between the highest token defined by the activity itself and the maximum base token value, 65535.

Note: Any added properties are in addition to the properties defined by an activity. There are three types of properties which may be added. Static properties will be stored in the activity document itself in the HCL Enterprise Integrator (HEI) Administrator database, and their values may be retrieved for future executions of the same activity. Dynamic properties are defined only for the current execution of the activity, and are discarded when the activity terminates. System properties are represented by operating system environment variables, and any retrieval or assignment of values immediately alters the environment variable's value.