ADD |
ADD(PARENT,CHILD,MNEMONIC,SEQUENCE) is an extrinsic
function to add the CHILD protocol to the PARENT protocol ITEM multiple.
Returns 1 for success, 0 for failure.
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
PARENT |
Input |
(Required) The name of the protocol you want to add
the CHILD protocol to.
|
CHILD |
Input |
(Required) The name of the protocol you are adding to
the PARENT protocol.
|
MNEMONIC |
Input |
(Optional) The value you want added to the MNEMONIC
field in the ITEM multiple for the CHILD in the PARENT protocol.
|
SEQUENCE |
Input |
(Optional) The value you want added to the SEQUENCE
field in the ITEM multiple for the CHILD in the PARENT protocol.
|
|
DELETE |
DELETE(PARENT,CHILD) is an extrinsic function to
delete the CHILD protocol from the ITEM multiple of the PARENT protocol.
Returns 1 for success, 0 for failure.
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
PARENT |
Input |
(Required) The name of the protocol you want to
delete the CHILD protocol from.
|
CHILD |
Input |
(Required) The name of the protocol you want to
delete from the PARENT protocol.
|
|
RENAME |
RENAME(OLD,NEW) is used to rename a protocol.
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
OLD |
Input |
(Required) The current name of the protocol.
|
NEW |
Input |
(Required) The new name of the protocol.
|
|
LKPROT |
LKPROT(PROTOCOL) is an extrinsic function that
returns the internal entry number of the PROTOCOL.
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
PROTOCOL |
Input |
(Required) The name of the protocol you want to
lookup.
|
|
OUT |
OUT(PROTOCOL,TEXT) is used to create or delete an Out
of Order message for a protocol.
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
PROTOCOL |
Input |
(Required) The name of the protocol you want to
assign the Out of Order TEXT.
|
TEXT |
Input |
(Required) The text of message to place in the OUT OF
ORDER MESSAGE field for the PROTOCOL. If set to null, the field will be
deleted.
|
|
TYPE |
TYPE(PROTOCOL) is an extrinsic function that returns
value for the PROTOCOL's TYPE field (#4) in the PROTOCOL file (#101).
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
PROTOCOL IEN |
Input |
(Required) The internal entry number (IEN) of the
protocol.
|
|
FIND |
FIND(RESULT,PROTOCOL) is used to find all parents for
the PROTOCOL and return the list in the RESULT array.
RESULT(0)=number of parents found or -1^error message
RESULT(ien)=protocol name
|
VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
RESULT |
Input |
(Required) The array to return the results, passed by
reference.
RESULT(0)=number of parents found or -1^error message
RESULT(ien)=protocol name
|
PROTOCOL |
Input |
(Required) The name of the protocol you want find the
parents of.
|
|