| 1 | Trace option setting | Input | Char(10) |
| 2 | Reserved | Input | Char(10) |
| 3 | Error detected | Output | Char(10) |
| 4 | Comparison data | Input | Char(*) |
The Trace commands such as STRCMNTRC, STRTRC, TRCINT and TRCCNN have the capability to watch for a specific event and end the trace when this event occurs. An event can be a message being sent to a specific message queue, history log, job log, or LIClog. If specified in the TRCPGM parameter, the watch for trace event facility will call a user-written program in the cicumstances specified in the Trace option setting parameter.
None.
The reason indicating the moment at which the user-written program was called. The possible values are:
| *ON | The watch for trace facility is starting. |
| *MSGID | A match on a message id specified on WCHMSG parameter occurred. |
| *LICLOG | A match on a LIC log specified on the WCHLICLOG parameter occurred. |
| *CMPDATA | The major and minor code of a LIC log matched, but the comparison data did not. |
| *INTVAL | The time interval specified on TRCPGMITV parameter is elapsed. |
| *WCHTIMO | The length of time to watch specified on WCHTIMO is elapsed. |
Indicates if the trace event facility should stop or continue running, or if an error on the user-written program was found. The possible values are:
| *CONTINUE | The trace and the watch for trace event facility will continue running |
| *STOP | The trace and the watch for trace event facility will be ended |
| *ERROR | Error detected by customer trace program. |
The format of the trace information depends on the Trace option setting causing the exit program to be called. The format of the Comparison data is as follows if the Trace option setting is *MSGID:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of trace information |
| 4 | 4 | CHAR(7) | Message ID |
| 11 | B | CHAR(9) | Reserved |
| 20 | 14 | BINARY(4) | Offset to comparison data |
| 24 | 18 | BINARY(4) | Length of comparison data |
| 28 | 1C | CHAR(*) | Message comparison data |
The format of the Comparison data is as follows if the Trace option setting is *LICLOG or *CMPDATA:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of trace information |
| 4 | 4 | CHAR(4) | LIC Log major code |
| 8 | 8 | CHAR(4) | LIC Log minor code |
| 12 | C | CHAR(8) | LIC Log identifier |
| 20 | 14 | BINARY(4) | Offset to comparison data |
| 24 | 18 | BINARY(4) | Length of comparison data |
| 28 | 1C | CHAR(*) | LIC Log comparison data |
The format of the Comparison data is as follows if the Trace option setting is *ON, *INTVAL or *WCHTIMO:
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Length of trace information (always 4 at this time) |
Length of trace information. The length of the Comparison data parameter passed to the user-written exit program.
Length of comparison data. The length of the user specified text to be compared against the event data.
LIC Log identifier. The LIC Log entry identifier of the LIC Log that occurred.
LIC Log major code. The major code of the LIC Log that occurred.
LIC Log minor code. The minor code of the LIC Log that occurred.
LIC Log comparison data. The user specified text string used to compare against the entry data of the watched for log entry.
Message ID. The identifier of the message that occurred.
Message comparison data. The user specified text string used to compare against the entry data of the watched for message ID.
Offset to comparison data. The offset to the field that holds the comparison data.
See the following for more information:
| Top | Communications APIs | APIs by category |