| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Source file name | Input | Char(*) |
| 5 | Error code | I/O | Char(*) |
The Retrieve Source Path Name (QteRetrieveSourcePathName) API returns the full source path name for a Java™ source file.
This API expects the DEBUGSOURCEPATH environment variable to be set to one or more directory paths that contain Java source files. These directory paths are used to search for the Java source file specified by the source file name parameter. If the Java source file is found, the full source path name is returned in the receiver variable. If the Java source file is not found or if the DEBUGSOURCEPATH environment variable is not set, a CPF959E error is returned.
A variable that is to receive the information requested. You can specify the size of this area to be smaller than that needed to hold the information. In this case, only part of the information is returned. The number of bytes that the API needs to return all of the information, however, is still returned.
The length of the receiver variable. The minimum length is 8 bytes.
It is suggested that a length of 8 be passed to the API, which fills in the first two fields of the receiver variable. The bytes available field indicates how much space must be provided. This space can then be obtained and a second call can be made to the API.
The content and format of the full source path information that is returned. The only valid value for this parameter is:
| SRCP0100 | Source path information. For more information, see SRCP0100 Format. |
The null-terminated Java source file name (such as Hello.java).
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table shows the format of the receiver variable for the SRCP0100 format. For more information on the fields, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Offset to source path name |
| 12 | C | BINARY(4) | Length of source path name |
| CHAR(*) | Source path name | ||
Bytes available. The number of bytes of data available to be returned to the user.
Bytes returned. The number of bytes of data returned to the user.
Length of source path name. The length of the full source path name returned.
Offset to source path name. The offset from the start of the receiver variable to the source path name.
Source path name. The path name of where the Java source file resides. The Java source file name is returned as part of the source path name (for example, /home/javasource/Hello.java). The source path name is returned in the CCSID of the job.
| Message ID | Error Message Text |
|---|---|
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF959E E | Source file not found. |
[ Back to top | Debugger APIs | APIs by category ]