%GetItemType function


Function
The function detects a type of entered column of the structure or structured variable.
Declaration


INT %GetItemType(
   HBJ in  objRef,
   INT in col
 )
Parameters


objRefAn expression of the HBJ type - a reference to an object of Structured variable type or Structure definition.
colColumn index.
Description
The function gets back an invalid value:


  • if objRef is the reference to unknown object, or the object is not Structured variable type or Structure definition,
  • if the value of parameter col is out of range which is given by columns number of relevant object.

    Value type is expressed by an integer according to the following table:


     
    Column type

    Value

    Logical0
    Integral1
    Real2
    Absolute time3
    Relative time4
    Text5
    Object6


Example


 RECORD (SD.Struct)_rec
 INT _itemType
 
 _itemType := %GetItemType(SD.Struct\HBJ, 1)
 _itemType :=  %GetItemType(SV.Struct\HBJ, 3)
 _itemType :=  %GetItemType(_rec\HBJ, 2)

ESL extended functions
Function arguments - types