Retrieve Debug Attribute (QteRetrieveDebugAttribute) API
Required Parameter Group:
| 1 | Debug attribute | Input | Char(10) |
| 2 | Attribute value | Output | Char(10) |
| 3 | Error code | I/O | Char(*) |
Service Program: QTEDBGS
Threadsafe: No
The Retrieve Debug Attribute (QteRetrieveDebugAttribute) API is used to retrieve the attributes of the source debug session. These attributes may be any of the following:
- Default attributes established when the debug session was started
- Attributes changed with the Set Debug Attribute API
- Attributes changed by the Change Debug (CHGDBG) command
The attributes of the debug environment cannot be retrieved unless the job is currently in debug mode.
Authorities and Locks
None.
Required Parameter Group
- Debug attribute
- INPUT; CHAR(10)
The name of the debug environment attribute that is retrieved. The valid values for this parameter are:
*UPDPROD Retrieves the value of the update production files attribute. *DEBUGJOB Retrieves an indicator of which job is being debugged. *OPMSRC Retrieves the value of the OPM source debug attribute.
- Attribute value
- OUTPUT; CHAR(10)
The current value of the attribute identified in the debug attribute parameter.
When the debug attribute parameter contains *UPDPROD, the attribute value parameter can have one of the following values:
*YES Allow the updating of production files while in debug mode. *NO Do not allow the updating of production files while in debug mode. When the debug attribute parameter contains *DEBUGJOB, the attribute value parameter can have one of the following values:
*LOCAL The debug session is debugging programs that run in the job in which this API is running. *REMOTE The debug session is debugging programs that run in the job specified in the Start Service Job (STRSRVJOB) command. When the debug attribute parameter contains *OPMSRC, the attribute value parameter can have one of the following values:
*YES Allow OPM programs that have source debug data to be debugged by using the ILE debug APIs. *NO Do not allow OPM programs to be debugged by using the ILE debug APIs.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF9541 E | Not in debug mode. |
| CPF9549 E | Error addressing API parameter. |
| CPF9559 E | Debug attribute parameter not valid. |
API introduced: V2R3
[ Back to top | Debugger APIs | APIs by category ]