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

$$ADD^XPDPROT(): Add Child Protocol to Parent Protocol

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

Description

The $$ADD^XPDPROT extrinsic function adds a child input protocol to a parent input protocol ITEM (#10) Multiple field in the PROTOCOL (#101) file.

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

Format

  $$ADD^XPDPROT(parent,child[,mnemonic][,sequence])

Input Parameters

parent:

(required) Name of the parent input protocol in the PROTOCOL (#101) file to which a child input protocol should be added.
child:

(required) Name of the child input protocol being added to the parent input protocol in the PROTOCOL (#101) file.
mnemonic:

(optional) The mnemonic value to be added to the MNEMONIC (#2) field in the ITEM (#10) Multiple field in the PROTOCOL (#101) file for the child in the parent input protocol.
sequence:

(optional) The sequence value to be added to the SEQUENCE (#3) field in the ITEM (#10) Multiple field in the PROTOCOL (#101) file for the child in the parent input protocol.

Output

returns:

Returns:

  • 1—Success, child input protocol added to the input parent input protocol ITEM (#10) Multiple field in the PROTOCOL (#101) file.

  • 0—Failure, child input protocol not added to the input parent input protocol ITEM (#10) Multiple field in the PROTOCOL (#101) file.