/
GetStTextRef

GetStTextRef

SlovenskyEnglish

%GetStTextRef function

Function

  The function detects HBJ of object Status text type which is attached to the object.

Declaration

INT %GetStTextRef( HBJ in objRef )

Parameters

objRef

An expression of the HBJ type - a reference to an object.

Description

The function returns an invalid value if objRef refers to an unknown object. If the function returns the value 0, the given object does not have a Status Text object assigned.

If the objRef object is identified only by its value (i.e., there is no reference between the object and the ESL script) and the function returns an invalid value, it is necessary to call the %OpenRefToObject function before invoking it.

Example

INT _stTextHBJ _stTextHBJ := %GetStTextRef(U.value1)