%HI_OpenRow function

Function

The function makes accessible the row values of the object of the Structured variable type.

Declaration

 INT %HI_OpenRow(
   HBJ in refToStruct, 
   INT in index
   [BOOL in bAsync := @FALSE]
 )

Parameters

refToStruct	Reference to the object of the Structured variable type.
index	Structured variable row.
bAsync	@TRUE - asynchronous function. @FALSE - synchronous function.

Description

The function makes accessible the values of the structured variable row given by the parameter index. The structured variable is defined by the parameter refToStruct of HBJ type (for example: SV.Structure\HBJ). Value defined in the parameter index is not checked because of the size of the structured variable.

According to the parameter bAsync, the function is:

Asynchronous (bAsync = @TRUE)
The function call is basically a request for updating the values of given row. Therefore the time, when the values will be updated depends on the total system load. Return value of the function is 0.
Synchronous (without the parameter bAsync, or bAsync = @FALSE)
After terminating the function call, the values in the row are updated. Return value of the function is _ERR_NO_ERROR when it was successfully executed.

Note

For a purposeful use of the function, there must be enabled the filtering of the structured variable values - creating an indexed local variable for the structured variable with enabled filtering.

Example

To make accessible the values in the row 5 of the structured variable SV.Structure:

INT  _retCode
 TEXT _errMsg
 
 _retCode := %HI_OpenRow(SV.Structure\HBJ, 5)
 IF  _retCode # _ERR_NO_ERROR THEN
   _errMsg := "%HI_OpenRow(SV.Structure\HBJ ErrorCode = " + %IToStr(_retCode)
 
 ELSE  ; values are accessible
 
 ENDIF

Related pages: