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

OUT^XPDMENU(): Edit Option's Out of Order Message

Reference Type: Supported, Category: Menu Manager, ICR#: 1157

Description

The OUT^XPDMENU API creates or deletes an out of order message for an option; this action effectively puts the option out of order or back in order.

Format

  OUT^XPDMENU(option,text)

Input Parameters

option:

(required) Name of option in which to place a value in the OUT OF ORDER MESSAGE (#2) field in the OPTION (#19) file.
text:

(required) Text of message to place in option's OUT OF ORDER MESSAGE (#2) field.

If this is not NULL, the text is stored in the option's OUT OF ORDER MESSAGE (#2) field and the option is placed out of order.

If this parameter is passed as a NULL string, the current OUT OF ORDER MESSAGE (#2) field value is deleted, and the option is put back in order.

Output

none.