|
|
|
The function code contained in a fullword addressed by the first word of the parameter list is a binary value that is right-aligned, with all high-order bits set to zero. The following function codes are used:
This indicates that the region has just been initialized. Any initialization processing that the exit needs to do, such as opening required data sets, should be done now.
The second word of the parameter list passed to the exit for function code 0 contains the address of an area, formatted as described below.
|
Byte |
Description |
|
|---|---|---|
|
00:03 |
In this full word, the exit can store the address of a message that is to be logged to the activity log and sent to Monitor class operators. On return from any call to the exit, this word is checked; if the value is non-zero, it is assumed to be the address of a half-word length followed by the text. |
|
|
04:04 |
Operating system indicator. Values are: |
|
|
X‘02’ |
MSP, MSP/AE, MSP/EX |
|
|
X’10’ |
z/OS |
|
|
05:05 |
SMF record identifier set by the SYSPARMS SMFID= command. |
|
|
06:17 |
System identifier set by the SYSPARMS ID= command. |
|
When processing completes successfully, the exit returns control to the caller with a return code of 0 in register 15. Any other value in R15 is regarded as indicating that processing was unsuccessful and the exit subtask is terminated abnormally and assigned User Abend reason code 390-01.
This indicates that a CNM record has been received by NEWS. For this function code only, the second word of the parameter list contains the address of the CNM record received. The actual CNM record is prefixed by a length field, so the format of the record presented to the exit is described in this section.
|
Byte |
Description |
|---|---|
|
00:01 |
Length of record including this 4-byte prefix |
|
02 :03 |
Always X‘0000’ |
|
04 :nn |
Length of CNM record data (variable) |
The processing performed by the exit on the record received is unrestricted, but it should be noted that extensive delays in processing may cause NEWS to reach internal queue limits and result in CNM records being lost.
Note: The record presented to the exit is a copy of the record received by NEWS only. No modification can be made to the record actually processed by NEWS when the exit returns control. The record with its length field prefix is suitable for writing to a variable blocked data set.
When control is returned by the exit, R15 must be set to one of the following (decimal) return codes:
|
Return Code |
Description |
|---|---|
|
0 |
Processing complete. NEWS continues processing this record and passes the next CNM record to the exit when it arrives. |
|
4 |
Processing complete. NEWS ignores this record and passes the next CNM record to the exit when it arrives. Records that have this return code are not passed to CNMPROC. |
|
8 |
Processing complete. NEWS continues processing this record but makes no further calls to the exit. |
|
12 |
Processing complete. NEWS ignores this record (unless it is a solicited response) but makes no further calls to the exit. |
Any other value in R15 is regarded as indicating unsuccessful processing and the exit subtask is abnormally terminated and assigned User Abend reason code 390-02.
Although TR-INQ RUs (Translate-Inquiry RUs) are passed to the user exit, the return code set by the exit for these RUs is not checked. Processing of TR-INQ RUs proceeds by the Alias Name Translation Facility of NEWS being called to format a TR-REPLY RU.
This indicates that your region is terminating. It alerts the exit to perform any cleanup processing required, such as closing data sets. The termination of your region cannot proceed until the exit returns control.
On successful completion of processing, the exit returns control to the caller with a return code of 0 in register 15. Any other value in R15 is regarded as indicating unsuccessful termination and the exit subtask is abnormally terminated with User Abend reason code 390-03.
| Copyright © 2012 CA. All rights reserved. |
|