Records That OPSCPF Returns

OPS/REXX Built-in Functions › OPSCPF Function › Records That OPSCPF Returns

Records That OPSCPF Returns

The OPSCPF function places a line in the external data queue (EDQ) for each command prefix it finds. OPSCPF then returns the number of lines it added to the EDQ. Each line added to the EDQ is formatted as follows:

Word Number	Length	Description
1	8	The CPF prefix string.
2	8	The name of the application that owns the prefix. This is an arbitrary name that the user of CPF services supplies; it does not always correspond to a job name.
3	8	The system to which commands with this prefix are routed.
4	8	The scope of the prefix. Possible values are SYSTEM and SYSPLEX.
5	1	Indicates whether the prefix is removed from the command before it is presented to the target system. Possible values are Y and N.
6	8	The FAILDISP value that was specified when the CPF prefix was defined. Possible values are RETAIN, PURGE, and SYSPURGE. These values indicate the disposition of a defined prefix when the owning address space or system terminates. For further information, see your IBM documentation.

Note: The lengths of the preceding words may change in a future release, but their relative position (word number) will not change.

Examples: OPSCPF function

This sample OPSCPF statement produces output similar to the sample output that directly follows it:

temp = OPSCPF(“I”)

do temp
  pull line
  say line
end

Sample output:

$       JES2     XE13     SYSTEM   N SYSPURGE

$       JES2     XE03     SYSTEM   N SYSPURGE
OA>     OPSAOSF  XE03     SYSPLEX  N PURGE
EA>     OPSAECF  XE03     SYSTEM   N PURGE

This sample OPSCPF statement returns the number of CPF prefixes that begin with the string “OPS” to the variable temp1:

temp1 = OPSCPF(“I”,”OPS”) /* Get a count of prefixes starting with OPS */

temp2 = OPSCLEDQ()        /* Clear the EDQ of any OPSCPF output */