Verbs and Built-in Functions › &PPI SEND

&PPI SEND

Sends data to a PPI receiver.

&PPI SEND TOID=name 
        [ OPT={ NONE | ASIS | HEXPACK } ]  
        [ DATA=data |
          VARS=prefix* [ RANGE=(start,end) ] |
          ARGS [ RANGE=(start,end) ] |
          VARS=(list) |
          MDO=stem ]

Operands:

SEND

The SEND option of the &PPI verb allows an NCL process to send data to any defined PPI receiver. The receiver need not be another NCL process. If the sending process is not defined (via &PPI DEFINE), the sender ID used is #nnnnnn. nnnnnn is the 6-digit (leading zeros) NCL ID.

TOID=name

A required parameter, providing the PPI receiver ID to send to. The ID must be a valid PPI receiver ID (see earlier in this document). It must be defined, although not necessarily active.

OPT={ NONE | ASIS | HEXPACK }

An optional parameter that indicates how the supplied data is to be processed before sending. This operand is only valid when the data to send as the generic alert is specified using the DATA= operand.

NONE

The default, indicates that the data is to have trailing blanks stripped, but is to otherwise be left alone.

ASIS

Indicates that the data is to be completely left alone. This allows passing binary data in NCL tokens with no alteration.

HEXPACK

Indicates that the data supplied is character-format hexadecimal strings. Each string must contain an even number of hexadecimal characters. The strings are each packed to binary and then abutted together. The resulting binary data is sent as is.

DATA=data

This operand, if specified, delimits the start of the data to send as the generic alert. The data starts immediately after the DATA= keyword.

VARS=prefix* [ RANGE=(start,end) ] |ARGS= [ RANGE=(start,end) ]VARS=(list) |

The contents of the variables or arguments specified are concatenated to form the data which is sent as the generic alert.

MDO=stem

The data within the MDO is sent as the generic alert.

Note:

If the data is successfully sent, and the target receiver is active, &RETCODE will be set to 0. If the data is queued and the receiver is inactive, &RETCODE will be set to 4. Other values indicate an error of some sort. &ZFDBK is inspected to determine the exact PPI return code.

More information:

Examples