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

PUT^XPAR(): Add/Update Parameter Instance

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

Description

The PUT^XPAR API adds or updates a parameter instance and bypass the input transforms.

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

  PUT^XPAR(entity,parameter[,instance],value[,.error])

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.
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.
value:

(required) Can be passed in external or internal format. If using internal format for a POINTER type parameter, the value must be preceded by the grave accent (`) character.

If the value is being assigned to a WORD-PROCESSING parameter, the text can be passed in the subordinate nodes of Value [e.g., Value(1,0)=Text] and the variable "Value" itself can be defined as a title or description of the text.

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 PUT^XPAR(“SYS”,”XPAR TEST MULTI FREE TEXT”,0,”Good times”,.ERROR)