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

OUT^XPDPROT(): Edit Protocol's Out of Order Message

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

Description

The OUT^XPDPROT API creates or deletes an "Out of Order" message in the DISABLE (#2) field in the PROTOCOL (#101) file for the input protocol.

NOTE: This API was released with Kernel Patch XU*8.0*547.

Format

  OUT^XPDPROT(protocol,text)

Input Parameters

protocol:

(required) Name of the protocol in the PROTOCOL (#101) file to which the "Out of Order" text is assigned.
text:

(required) Text value:

  • Text—Message text to place in the DISABLE (#2) field in the PROTOCOL (#101) file for the input protocol.

  • NULL—Delete any message text in the DISABLE (#2) field in the PROTOCOL (#101) file for the input protocol.

Output

returns:

Returns:

  • Text—Updated message text in the DISABLE (#2) field in the PROTOCOL (#101) file for the input protocol. Marking the protocol "Out of Order."

  • NULL—Deleted message text in the DISABLE (#2) field in the PROTOCOL (#101) file for the input protocol.