GET_OH_IDNR

Upon its creation, each object obtains an internal number. You can use the GET_OH_IDNR script function to retrieve this internal number.

Important! As of v11, you can only query an OH_IDNR from the same client. Trying to access a different client results in an error message in the message window, and returns an invalid OH_IDNR.

Syntax

GET_OH_IDNR (Object Name)

Parameters

  • GET_OH_IDNR
    Retrieves the internal number of an object
  • Object name
    Name of the object
    Format: script literal or script variable

Return codes
This script function returns the internal number of a particular object. 0 is returned if the object does not exist.

  • 0
    The object does not exist

Example

The following example retrieves the internal number of an object called MM.DAY:

:SET &RET# = GET_OH_IDNR("MM.DAY")

See also: