%GetColDescript function

Function

The function returns the description of the specified structure column.

Declaration

TEXT %

GetColDescript

(
    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 description of a given column of specified structure (or structure definition) as a text. The column is given by its index number (starting from 1). Expression of HBJ type returns an object attribute \HBJ.
If the column is not from the structure (or structure definition) range or the object is not the structure (or structure definition), the function returns an invalid value.

 INT _iHbj
 INT _icol
 BOOL _bOk
 TEXT _description
 
 _iHbj := %StrToHBJ("SV.DATA")
 _iCol := 1
 
 _bOk := %OpenRefToObject(_iHbj,@TRUE)
 IF _bOk THEN
   _description := %GetColDescript(_iHbj,_iCol)
 ENDIF