DBIA2542 ICR (2542)

Name

Value

NUMBER

2542

IA #

2542

DATE CREATED

1998/09/21

CUSTODIAL PACKAGE

KERNEL

CUSTODIAL ISC

San Francisco

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

XUPARAM

NAME

DBIA2542

GENERAL DESCRIPTION

These are calls to set or get simple parameters from a
file that the site can edit.  The file is KERNEL PARAMETERS (#8989.2)

STATUS

Active

XUPARAM

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$GET

The call is $$GET^XUPARAM(<parameter name>[,style])
where 'parameter name' is a namespaced name for the parameter to lookup and
return the REPLACEMENT value or DEFAULT. The style parameter controls the
return value if both of these are empty.

Where 'style' controls how missing parameter entries are retuened, Valid value
are: "N" to return call name.
"V" to return "".
missing returns 0.

Kernel uses this to allow sites to select local edit templates.  i.e. S
DR="["_$$GET^XUPARAM("XUEDIT CHARACTERISTICS","N")_"]"

VARIABLES

TYPE

VARIABLES DESCRIPTION

$$GET

Output

Returns user defined data.

parameter name

Input

This is a user defined namespaced name.

style

Input

This optional input controls what is returned if
there isn't a replacement value or a default value.  Valid values are "N" to
return the call name.
"V" to return ""
missing returns 0.

SET

This entry point allows the setting of the
REPLACEMENT value in the file for a given entry.

VARIABLES	TYPE	VARIABLES DESCRIPTION
parameter name	Input	This is a user defined namespaced name.
value	Input	This is the replacement value.

LKUP

This entry point allows the creation of a entry.  S
X=$$LKUP^XUPARAM("XUEDIT PARAM","A")

VARIABLES	TYPE	VARIABLES DESCRIPTION
$$LKUP	Output	Returns -1 if the lookup was unsuccessful. Returns a positive value for success.
parameter name	Input	This is a user defined namespaced name.