%GetObjDescript function

Function

The function retrieves the description of the object specified by its unique identifier (HOBJ).

Declaration

TEXT %GetObjDescript(
   HBJ in objID
 )

Parameters

objID

Value of HBJ or INT types.

Description

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

Example

INT _hbj
 TEXT _desc
 
 ; HOBJ of the object Sec
 _hbj := %StrToHBJ("Sec")
 
 _desc := %GetObjDescript(_hbj)    ; variable _desc will contain the description of Sec
 
 ; object probably doesn't exist => _desc will be invalid value
 _desc := %GetObjDescript(928374)