%GetSelfHBJ function


Function
The function retrieves the unique identifier (HOBJ) of the object within the frame of which the script is interpreted (object of Event type or active picture).
Declaration


HBJ %GetSelfHBJ(
   BOOL in bBaseHBJ := @TRUE
 )
Parameters


bBaseHBJOptional parameter. Possible values:
  • @TRUE - the function retrieves the HOBJ of the non-instance object,
  • @FALSE - the function retrieves the HOBJ of the instance object.

Description

If the function is called in the context of a Unit event, it returns an event not a Unit HBJ.

Example

For the script of the E.Test event, there is valid:

 


INT _i


INT _i1



_i := E.Test\HBJ


_i1 := %GetSelfHBJ()


IF _i = _i1 THEN ; condition is always true


ENDIF
 
If given object is not open as an instance, then %GetSelfHBJ(@TRUE) = %GetSelfHBJ(@FALSE).
Note