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

GETLST^XPAR(): Return All Instances of a Parameter

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

Description

The GETLST^XPAR API is similar to the ENVAL^XPAR API; however, it returns all instances of a parameter.

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

  GETLST^XPAR(.list,entity,parameter[,format][,.error][,gbl])

Input/Output Parameters

.list:

(required) The array passed as .list is returned with all of the possible values assigned to the parameter.

REF: To see how this data can be returned, see the format parameter description.

If the gbl parameter is set to 1, then the .list parameter becomes an input and holds the closed root of a global where the GETLST^XPAR API should put the output [i.e., $NA(^TMP($J,”XPAR”))].

Input Parameters

entity:

(required) Entity can be set to the following:

  • Internal variable pointer (nnn;GLO(123,).

  • External format of the variable pointer using the three-character prefix (prefix.entryname).

  • Prefix alone to set the parameter based on the current entity selected.

This works for the following entities:

  • USR—Uses current value of DUZ.

  • DIV—Uses current value of DUZ(2).

  • SYS—Uses system (domain).

  • PKG—Uses the package to which the parameter belongs.
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.
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”.
gbl:

(optional) If this optional parameter is set to 1, then the .list parameter must be set before the call to the closed global root where the return data should be put. For example:

     GETLST^XPAR($NA(^TMP($J)),ent,par,fmt,.error,1)

Output Parameter

.error:

(optional) If used, must be passed in by reference. It returns any error condition that may occur:

  • 0 (Zero)—If no error occurs.

  • #^errortext—If an error does occur.

    The # is the number in the VA FileMan DIALOG (#.84) file and the “errortext” describes the error.

Example

     >D GETLST^XPAR(.LIST,”SYS”,”XPAR TEST MULTI FREE TEXT”,,.ERROR)