%GetColName function

Function

The function returns the name of the specified structure column.

Declaration

TEXT %GetColName(
    HBJ in objRef, 
    INT in index
 )

Parameters

objRef	Reference to an object of Structure definition or Structured variable type.
index	Column index.

Example

The function returns the name of a given column of specified structure (or structure definition) as a text. The column is given by its positional number (starting with 1). Expression of Hbj type returns an object attribute \HBJ.

 %GetColName(SV.Structure\HBJ, 1)    ; returns the value of "Text"
 %GetColName(SV.Structure\HBJ, 2)    ; returns the value of "Int"
 %GetColName(SV.Structure\HBJ, 10)   ; returns invalid value

See also the attribute: \HBJ