Add Source Region Description (QteAddSourceRegionDescription) API
Required Parameter Group:
| 1 | Previous view number | Input | Binary(4) |
| 2 | Map target view number | Input | Binary(4) |
| 3 | Start line number | Input | Binary(4) |
| 4 | End line number | Input | Binary(4) |
| 5 | Preprocessor ID | Input | Binary(4) |
| 6 | Source region number | Output | Binary(4) |
| 7 | Error code | I/O | Char(*) |
Service Program: QTECRTVS
Threadsafe: No
When a preprocessor is called with an input view, it will read the view and translate parts or whole of the input view it interests to generate its output view. If the preprocessor wants the translated symbols can be debuggable, it can create a source region particularly for those translated parts in the input view by Add Source Region Description(QteAddSourceRegionDescription) API. This API will add a new source region associated with the previously added input view. The source region is used to map symbols defined in the region to the symbols in the output view.
Every source region should be part or the whole of the previous view. The previous view can be a *TEXT or *LISTING view but it cannot be a block view, statement view nor another source region. The processors should guarantee the current adding source region doesn’t overlap with the existing source regions in the previous view. If this happens, the region will not be added and the API returns with an error. This API can be called multiple times and each time a new source region will be added. So a processor can add any number of different source regions. All those added source regions should have the same CCSID with the previous view.
When a source region is created successfully, a handle to it will be returned in the form of region number. This number will be needed when adding blocks associated with it.
Authorities and Locks
None.
Required Parameter Group
- Previous view number
- INPUT; BINARY(4)
The number of the previously added view which this source region is enclosed in. The previous view can be a *TEXT view or *LISTING view.
- Map target view number
- INPUT; BINARY(4)
The number of target view which the previous view is mapped to.
- Start line number
- INPUT; BINARY(4)
The line number from which the source region starts.
- End line number
- INPUT; BINARY(4)
The line number where the source region ends.
- Preprocessor ID
- INPUT; BINARY(4)
The identifier of the preprocessor that created this source region. Supported values are:
0 SQL preprocessor. - Source region number
- OUTPUT; BINARY(4)
The number used to identify this source region. Other APIs can refer this region by this number.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of this 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. |
| CPF9542 E | View not found. |
| CPF9547 E | Previous view not correct. |
| CPF9549 E | Error addressing API parameter. |
| CPF9556 E | API not valid at this time. |
| CPF9C9E E | Source region overlaps existing regions. |
| CPF9C9F E | Preprocessor ID not valid. |
| CPF9CA0 E | Source region scope not valid. |
| CPF9CA1 E | Map target view not correct. |
| CPF955D E | View data overflow. All debug data lost. |
API introduced: V7R3
[ Back to top | Debugger APIs | APIs by category ]