%GetItemValue function

Function

The function retrieves the value of the structure item with a specified row and column.

Declaration

UNIVAL  %GetItemValue(
   HBJ in objRef, 
   INT in row, 
   INT in col[,
   BOOL in bHBJ = @FALSE]
)

Parameters

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

Example

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

The following assignments:

TEXT _i

_i := SV.Structure[2]^Text

_i := %GetItemValue(SV.Structure\HBJ, 2, 1)

return the same values.

See also the attribute: \HBJ

Related pages: