Kernel Toolkit 7.3 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

$$GET^XPAR(): Return an Instance of a Parameter

Reference Type: Supported, Category: Toolkit—Parameter Tools, ICR#: 2263

Description

The $$GET^XPAR extrinsic function retrieves the value of a parameter. The value is returned from this call in the format defined by the input parameter named “format.”

REF: For descriptive information about the elements and how they are used in the callable entry points into XPAR, see the “Definitions” section in the "Toolkit—Parameter Tools" section in the Kernel 8.0 & Kernel Toolkit 7.3 Developer's Guide.

Format

  $$GET^XPAR(entity,parameter[,instance][,format])

Input Parameters

entity:

(required) Entity is defined as the single entity or group of entities you want to look at in order to retrieve the value. Entities can be passed in internal or external format [e.g., LOC.PULMONARY or LOC.’57 or 57;SC(]. The list of entities in this variable can be defined as follows:

  • A single entity to look at (e.g., LOC.PULMONARY).

  • The word ALL that tells the utility to look for values assigned to the parameter using the entity precedence defined in the PARAMETER DEFINITION (#8989.51) file.

  • A list of entities you want to search (e.g., “USR^LOC^SYS^PKG”). The list is searched from left to right with the first value found returned.

  • Items 2 or 3 with specific entity values referenced such as:

    • ALL^LOC.PULMONARY—To look at the defined entity precedence, but when looking at location, only look at the PULMONARY location.

    • USR^LOC.PULMONARY^SYS^PKG—To look for values for all current user, PULMONARY location, system, or package).
parameter:

(required) Can be passed in external or internal format. Identifies the name or internal entry number (IEN) of the parameter as defined in the PARAMETER DEFINITION (#8989.51) file.
instance:

(optional) Defaults to 1 if not passed. Can be passed in external or internal format. Internal format requires that the value be preceded by the grave accent (`) character.
format:

(optional) The format input parameter determines how the value is returned. It can be set to the following:

  • I—Internal; returns list(#) = “internal value”.

  • Q—Quick; returns list(#) = “internal instance^internal value”. Returns the value in the quickest manner (default if not specified).

  • E—External; returns list(#) = “external instance^external value”.

  • B—Both; returns both list(#,“N”) = “internal instance^external instance” and list(#,“V”) = “internal value^external value”.

  • N—Returns list(#) = “internal value^external value”.

Output

returns:

Returns the parameter value in the format defined by the format input parameter.