Page tree
Skip to end of metadata
Go to start of metadata

Identifiers

Identifiers in the script provide the access to the value of an object or a local variable. In case of a structured value, it is possible to access whole value, row of structured variable or its item by through an identifier.

The following figure shows and names all possible methods of the reference to a value, which are used in ESL:

Value identifier

Notes:

  • Only coloured boxes shows a value.
  • A green-coloured box represents a value (group of values in case of a structure), with no references to other objects (ALIAS or column of Object type).
  • A red-coloured box represents a value (group of values in case of a structure), with references to other objects (ALIAS or column of Object type).
  • A combination of red and green colours represents a value (group of values in case of a structure) where values and references may be combined.
  • Each method of reference to value is named (red text above box).

Examples for individual types of references to value:

Reference type (name) Value description Example
IC_C Constant. "Text", 1, ...
IC_HOBJ_EXPR Expression of INT type that is interpreted as the reference to an object. The object is enclosed in brackets on the position where the identifier is expected. (20), (Sec\HBJ)
IC_VOBJ_EXPR Three comma-separated expressions enclosed in brackets:
  1. unique identifier - expression of HOBJ type
  2. row number - expression of INT type
  3. column number - expression of INT type
Note: The reference may only be used as a reference to a historical value for the GETARCHVAL, GETARCHARR a SETDT_LINEOBJ actions.
(H.Struct\HBJ, 2, 3)
IC_O Object of a type other than Structured variable. Sec, SysTime, I/O tag, ...
IC_O_R Object of Structured variable type. SV.Structure
IC_O_R_R Row of object Structured variable type. If the index is 0, it means whole value analogous to IC_O_R. SV.Structure[2], SV.Structure[0]
IC_O_R_RIA Row item of object of Structured variable type. The item is Object type (reference to object). SV.Structure[2]^Object
IC_O_R_RIN Row item of object of Structured variable type. The item is not Object type (reference to object). SV.Structure[2]^Text
IC_L Local variable of BOOL, INT, TEXT, TIME or REAL types.  
IC_L_CONST Constant (initialized) local variable of BOOL, INT, TEXT, TIME or REAL type.  
IC_L_AN Local variable of ALIAS type (untyped). ALIAS _a
IC_L_AT Local variable of typed ALIAS type (without index or access to item). ALIAS (SD.RecordDef) _recA
IC_L_AT_R Row of object of Structured variable type, to which the typed ALIAS currently refers. If the index is 0, it means whole value. _recA[1] or the whole value
_recA[0]
IC_L_AT_RIA Row item of an object of Structured variable type, to which the typed ALIAS currently refers. The item is Object type (reference to object). _recA[1]^Object
IC_L_AT_RIN Row item of an object of Structured variable type, to which the typed ALIAS currently refers. The item is not Object type (reference to object). _recA[1]^Text
IC_L_RNA Local variable of Record type. Reference to the whole value. RECORD NOALIAS (SD.RecordDef) _recNA
IC_L_RNA_R Local variable row of Record type. If the index is 0, it means whole value similarly to IC_L_RNA. _recNA[1] or the whole value _recNA[0]
IC_L_RNA_RIA Row item of a local variable of Record type. The item is Object type (reference to object). Considering forbidden references to objects, this item represents an simple value (without predefined value type). _recNA[1]^Object
IC_L_RNA_RIN Row item of a local variable of Record type. The item is Object type (reference to object). Unlike IC_L_RNA_RIA, the value type of the item is defined. _recNA[1]^Text
IC_L_R A local structured variable. Reference to the whole value. RECORD (SD.RecordDef) _rec
IC_L_R_R Row of local variable of Record type. If the index is 0, it means whole value analogous to IC_L_R. _rec[1] or the whole value
_rec[0]
IC_L_R_RIA Row item of a local variable of Record type. The item is Object type (reference to object). _rec[1]^Object
IC_L_R_RIN Row item of a local variable of Record type. The item is not Object type (reference to object). _rec[1]^Text
IC_L_NR Local variable of Record type (the structure type is not defined). The reference to the whole value. RECORD () _rec
IC_L_NR_R The row of local variable of Record type (the structure type is not define). If the index is 0, it is the whole value like IC_L_NR. _rec[1] or the whole value
_rec[0]
IC_L_NR_RII The row item of local variable of Record type (the structure type is not define). The column is defined by the number. _rec[1]^_iCol
IC_L_NRNA Local variable of Record type (the structure type is not define). The reference to the whole value. RECORD NOALIAS () _recNA
IC_L_NRNA_R The row of local variable of Record type (the structure type is not define). If the index is 0, it is the whole value like IC_L_NRNA. _recNA[1] or the whole value
_recNA[0]
IC_L_NRNA_RII The row item of local variable of Record type (the structure type is not define). The column is defined by the number. _recNA[1]^_iCol
Write a comment…