Start Source Debug (QteStartSourceDebug) API
Required Parameter Group:
1 | Qualified program name | Input | Char(20) |
2 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Service Program: QTEDBGS
Threadsafe: No
The Start Source Debug (QteStartSourceDebug) API lets you use the source debugging APIs in your session. This allows the debugging of any ILE programs or service programs that contain debug information. OPM CL, OPM RPG, and OPM COBOL programs that are created with OPTION(*SRCDBG) or OPTION(*LSTDBG) may also be debugged.
Your job must be put in debug mode before this API is issued. Debug mode is a special environment in which the debug functions can be used in addition to routine system functions. Debug functions cannot be used outside debug mode. To start debug mode, you must issue the Start Debug (STRDBG) command.
The Start Source Debug API must be used before an ILE or OPM program can be debugged. This API requires that you specify a user exit program to be called by the source debugger support to handle breakpoints, steps, and unmonitored exceptions.
Your job remains in debug mode until an End Source Debug (QteEndSourceDebug) API is issued or until your current routing step ends.
If the job is servicing another job, the job will actually debug the job being serviced.
Authorities
The authority requirements for the exit program specified by the Qualified program name parameter are as follows:
- Program Authority
- *USE
- Library Authority
- *USE
The authority requirements for all programs to be debugged are as follows:
- Program Authority
- *CHANGE, or *USE with *SERVICE special authority
- Library Authority
- *USE
Required Parameter Group
- Qualified program name
- INPUT; CHAR(20)
The name of the exit program that is called whenever a breakpoint, a program step, or an unmonitored exception occurs. See Program-Stop Handler Exit Program for a discussion of the parameters passed to this program to assist in processing breakpoint, step, and exception information.
The first 10 characters contain the program name. The second 10 characters contain the name of the library where the program is located. Both entries must be left-justified.
- 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. |
CPF9540 E | Already in debug mode. |
CPF9541 E | Not in debug mode. |
CPF9803 E | Cannot allocate object &2 in library &3. |
CPF9809 E | Library &1 cannot be accessed. |
CPF9810 E | Library &1 not found. |
CPF9811 E | Program &1 in library &2 not found. |
CPF9820 E | Not authorized to use library &1. |
CPF9821 E | Not authorized to program &1 in library &2. |
CPF9549 E | Error addressing API parameter. |
API introduced: V2R3
[ Back to top | Debugger APIs | APIs by category ]