Set XDA Options (QxdaSetOptions) API
Required Parameter Group:
| 1 | Input structure | Input | Char(*) |
| 2 | Input structure format | Input | Char(8) |
| 3 | Error code | I/O | Char(*) |
Service Program: QXDAEDRS
Default Public Authority: *USE
Threadsafe: Conditional; see Usage Notes
The Set XDA Options (QxdaSetOptions) API is used to set options related to XDA.
Authorities and Locks
None.
Required Parameter Group
- Input structure
- INPUT; CHAR(*)
The structure is used to set options related to XDA. For the format of this parameter, see SETO0100 Format.
- Input structure format
- INPUT; CHAR(8)
The format of the input structure template being used. The possible value is:
SETO0100 Set Options structure.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
SETO0100 Format
The following table shows the information to pass in the SETO0100 format. For more details about the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(1) | Threadsafe |
| 1 | 1 | CHAR(1) | Trace mode |
| 2 | 2 | CHAR(1) | Server mode |
| 3 | 3 | CHAR(1) | Reserved1 |
| 4 | 4 | BINARY(4) | Trace file size |
| 8 | 8 | BINARY(4) | Offset to the trace configuration data |
| 12 | C | BINARY(4) | Length of the trace configuration data |
| 16 | 10 | CHAR(112) | Reserved2 |
| CHAR(*) | Trace configuration data | ||
Field Descriptions
Length of the trace configuration data. The length of the trace configuration data passed.
Offset to the trace configuration data. The offset from the beginning of the input structure to the trace configuration data in the input structure, in bytes.
Reserved1. Reserved field; it must be initialized to 0x00.
Reserved2. Reserved field; it must be initialized to 0x00.
Server mode. Indicates whether the user will connect to a QSQSRVR job or a QXDARECVR job. This should be specified before QxdaConnectEDRS is called. Thread safety must be enabled and the connection type must be local if server mode is enabled. The default is not to connect to a QSQSRVR job.
| 0 | Do not enable server mode in XDA. |
| 1 | Enable server mode in XDA. |
Threadsafe. Indicates whether thread safety should be used in XDA. This should be specified before QxdaConnectEDRS is called. The default is not to use thread safety in XDA.
| 0 | Do not use thread safety in XDA. |
| 1 | Use thread safety in XDA. |
Trace configuration data. Indicates whether the trace function should trace network flows, or to trace network data blocks, or both. The normal trace function must be enabled in order to take advantage of the trace configurations. The following trace options can be specified together with a comma separator:
| TRACENET | Trace network data flow in XDA. |
| TRACEDATABLOCK | Trace values inserted or removed from network data blocks. |
Trace file size. Indicates the size of the trace file in megabytes. The file is wrapped after the size is reached. The default is not to wrap the trace file. The maximum size is 2048 MB (2 GB).
| 0 | Do not wrap the trace file in XDA. |
Trace mode. Indicates the mode of the trace function that should be used in XDA. There are not any specific instructions for use. The default is not to enable tracing functionality in XDA.
| 0 | Do not enable tracing in XDA. |
| 1 | Enable tracing at an information level in XDA. |
| 2 | Enable tracing at an error level in XDA. |
| 3 | Enable tracing at the verbose level in XDA. |
Usage Notes
This function may be called from the initial thread of a job only for thread safety. This function can be called from any thread to enable the trace function. The trace function will be enabled for all connections within a given job.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C21 E | Format name &1 is not valid. |
| CPFB751 E | Parameter &1 passed not correct. |
| CPFB752 E | Internal error in &1 API. |
API introduced: V5R4