%StrToHBJ function

Function

The function returns the unique identifier (HOBJ) of the system object given by its name.

Declaration

HBJ%StrToHBJ(
   TEXT in objName
 )

Parameters

objName

Text expression.

Description

The function sends a query to the process D2000 Server to detect the unique identifier of the system object defined by the parameter objName. If the object doesn't exist or the parameter is an invalid value, the function returns invalid value.

Example

INT _hobj
 
 _hobj := %StrToHBJ("Sec")
 IF  _hobj # Sec\HBJ THEN
   ; error (condition must not be met)
   _hobj := 0
 ENDIF

In the example, the object's HOBJ is detected in two ways.