%HI_GetConnectedHBJ function

Function

The function %HI_GetConnectedHBJ returns the unique identifier (HOBJ) of the object connected to the displayer of Graph or Picture/Componet type.

Declaration


HBJ %HI_GetConnectedHBJ(
   INT in refId 
   [, BOOL in bPhysical := True]
)
Parameters
refIdReference to displayer (reference variable).
bPhysicalIf the value of parameter is True, the function will return the basic HOBJ of the connected object.
If the value of parameter is False, the function will return a dynamic (unique) HOBJ of the object connected as instance.
If connected object represents the picture, the values differ in case that the picture is connected as instance.
Description

If there is no connected object, the function returns 0.

Example
INT _i1
 INT _i2
 
 _i1 := T.Temperatures\HBJ
 %HI_SetConnectedObj(_Graph, _i1, 0)
 _i2 := %HI_GetConnectedHBJ(_Graph)
 
 ; The following condition will be always met
 IF _i1 = _i2 THEN
 ....
 

where:
_Graph - is RefId of Graph displayer type.
T.Temperatures - object of Graph type. The expression T.Temperatures\HBJ is HBJ type (reference to object)
The instance number is 0.

Note
See also %HI_GetConnectedInstance.

Related pages:

Graphic object manipulation functions
Function arguments - types

Napíšte komentár