Required Parameter Group:
Service Program: QTECRTVS
|
The calling program uses the Start View Creation (QteStartViewCreation) API to initialize the debug view creation environment. This API should be the first one of the view creation APIs to be called.
This calling program is usually a text preprocessor or a compiler. In this document, the term processor will be used to specify any program that reads input text and produces view data for the debugger.
The processor that calls the Start View Creation API must provide the names of the input source member read and the output source member created (if any).
The input member name is the name of the root source member read by the processor. If a previously run processor created this member, then view information is stored with the member. This view information is combined with that produced by the processor and stored in the output source member specified by the processor.
If an input member is specified and there is no view information in the associated space of the member, it is assumed that this member is the root source from which the program is created. It is also assumed that the processor that specifies this member is the first processor in the chain of processors that produces the program.
The processor creating the view supplies the CCSID in which all supplied text is stored. Thus, when view text is extracted, all supplied text is translated from this CCSID to the CCSID of the job. When view text (such as macro expansion text) is supplied, it must be supplied in the same CCSID. Text that comes from other files may be in any CCSID, as it will automatically be translated into the job's CCSID when the text is retrieved.
If no input member is specified, it is assumed that a previous processor created view information in a temporary space, instead of storing it in an output member. This is the case when a compiler runs and produces view information. Since the compiler does not produce an output member to be read by another processor, the view information is stored in a temporary location associated with the process, and no output file is specified.
Each processor creates view information that is combined with information produced by previous processors. The final, and complete, view information is stored by the binder in the module and program object associated space.
After the view information is complete, the End View Creation API should be called.
The input file must exist and be available at the time this API is issued. The output file must exist and be available at the time the QteEndViewCreation API is issued.
The name of the file member read by the processor creating debug data. This member may be a member created by the customer, or it may be the output of a previously run preprocessor. The special value of *NONE is used when input from the processor does not come from a source member. In general, the only processor which would indicate *NONE is the back end of the compiler.
This file may contain view information if it is created by a previously run preprocessor.
The structure of this parameter is specified by the format name parameter.
The file member written by the processor creating debug data. A special value of *NONE for the output file indicates that the view information created will remain with the job and will be passed to the next compilation step without being associated with a specific file. Generally, only the compiler uses this special value, as it does not create a source member to be read by another processor.
The associated space of this file will contain view information created by this processor in addition to view information created by any previous preprocessor steps. It is the responsibility of the processor to create this file and make it available before the QteEndViewCreation API is called.
The structure of this parameter is specified by the format name parameter.
The content and format of the information supplied by the calling program in the input file descriptor buffer and the output file descriptor buffer. The only valid value for format name is:
Whether the program creating debug view information wants the source debugger support to throw away any previously created view information. This allows a processor to force the view information created to be the only debug data available. In general, processors would specify *NO to allow any previous processor's view information to be included in the final program object.
The processor that creates view information.
The CCSID of any text supplied to the view creation APIs.
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | File name |
| 10 | A | CHAR(10) | File library |
| 20 | 14 | CHAR(10) | Member name |
File library. The name of the library that contains the file being listed. It is an AS/400 object name, left-justified, and padded with blanks.
File name. The name of the file being listed. It is an AS/400 object name, left-justified, and padded with blanks.
Member name. The name of the member in the file being listed. It is an AS/400 object name, left-justified, and padded with blanks.
|
Top
| Debugger APIs
| Source Debugger APIs Source Debugger APIs and Exit Programs | Create View APIs | APIs by category |
| [Information Center Home Page | Feedback ] | [Legal | AS/400 Glossary] |