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

%GetItemValue function


Function
The function retrieves the value of the specified structure item.
Declaration
UNIVAL  %GetItemValue(
   HBJ in objRef, 
   INT in row, 
   INT in col[,
   BOOL in bHBJ = @FALSE]
)

Parameters
objRef Reference to object of Structured variable type.
row Row index.
col Column index.
bHBJ If the value is @FALSE or parameter is not specified, the function returns value of the field.
If the value is @TRUE, the function returns the following according to the column type:
  - Column type Object: function returns the object identifier (HBJ), which refers to the field
  - Other column type: function returns the invalid value

Example
The function provides an alternative method of the access to items of a structure using the row and column index. In this context, structure is taken as a value matrix.

The following assignments:


 
TEXT _i
_i := SV.Structure[2]^Text
_i := %GetItemValue(SV.Structure\HBJ, 2, 1)

 

get the same values.

See also the attribute: \HBJ


Write a comment…