%GetItemStTextRef function

Function

The function detects HBJ of object Status text type which is attached to entered column of the structure or structured variable.

Declaration

INT %GetItemStTextRef(
   HBJ in  objRef,
   INT in col
 )

Parameters

objRef	Expression of HBJ type - reference to object of Structured variable type or Structure definition.
col	Column 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.
If function gets back the value 0, the object Status text is not assigned to specific column.

Example

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