|
|
|
Defines an NCL process to PPI.
&PPI DEFINE ID={ * | name } [ MAXQUEUE=n ]
Operands:
The DEFINE option of the &PPI verb allows an NCL process to register itself to PPI. It can optionally ask PPI to supply a unique receiver/sender ID. Once defined, the NCL process can use all other &PPI verb options. When sending data using &PPI SEND or &PPI ALERT, the defined name is used as the sender ID.
The DEFINE option can also be used by a defined process to alter the queue limit.
A required parameter that supplies the name that the procedure is to be registered to PPI under. If name is used, then it must be a valid PPI sender/receiver ID, as described earlier in this section. If * is used, PPI will supply a unique name, if possible.
If the process is already defined, then the * option cannot be used, and the name the procedure is defined under must be supplied. This name is available in the &ZPPINAME system variable. This is done when dynamically altering the queue limit.
If the NCL process is executing in the product region that is connected to the SSI that owns PPI, then names starting with NETV or NETM is used. Otherwise, they cannot, and a PPI return code of 40 (in &ZFDBK; &RETCODE of 12) will be returned.
An optional parameter, that allows setting of the defined receiver queue limit. For a new definition, the default value, if not specified, is 10.
The allowable range is 0 to 9999.
If altering the queue limit for an already-defined receiver, there is no default. Not specifying this parameter means that no change occurs.
Following a successful define, &RETCODE will be 0. &ZFDBK will also be 0. &ZPPINAME will contain the actual receiver ID allocated. This will equal the name supplied if a name was supplied, or will be the PPI-allocated name if an asterisk was used.
| Copyright © 2009 CA. All rights reserved. |
|