Kernel Toolkit APIs: ENVAL^XPAR

ENVAL^XPAR(): Return All Parameter Instances

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

Description

The ENVAL^XPAR API returns all parameter instances.

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

  ENVAL^XPAR(.list,parameter,instance[,.error][,gbl])

Input/Output Parameters

.list:

(required) 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. For example:

     $NA(^TMP($J,”XPAR”))

Input Parameters

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:

(required) 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.

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:

     S LIST=$NA(^TMP($J)) 
     ENVAL^XPAR(LIST,par,inst,.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.