%HI_GetConnectedInstance function

Function

The function %HI_GetConnectedInstance return the instance number of the object connected to the displayer of Graph or Picture/Componet type.

Declaration

INT %HI_GetConnectedInstance(
   INT in refId
   [, BOOL in bPhysical := True]
 )

Parameters

refId	Reference to the displayer `(`reference variable`).`
bPhysical	If the value of parameter is True, the function returns the real instance number of the picture (in some cases it is generated automatically by system and it is differing from the required number). If the value of parameter is False, the function returns required number of instance.

Description

The displayer is defined by the parameter refId.

If there is no connected object, the return value is 0.

Example

INT _i1
 INT _i2

_i1 := 1
 %HI_SetConnectedObj(_Trend, T.Temperatures\HBJ, _i1)
 _i2 := %HI_GetConnectedInstance(_Trend)

; the following condition will be always satisfied
 IF _i1 = _i2 THEN
 ....

where:
_Trend - is RefId of the displayer of Trend type.
T.Teploty - object of Graph type.
The instance number is 1.

Note