| 1 | Qualified user space name | Input | Char(20) |
| 2 | Format name | Input | Char(8) |
| 3 | Point-to-point connection profile name | Input | Char(10) |
| 4 | Error code | I/O | Char(*) |
The List TCP/IP Point-to-Point Jobs (QTOCLPPJ) API returns information about each connection job currently associated with the specified point-to-point connection profile.
The user space that receives the information and the library in which it is located. The first 10 characters contain the user space name. The second 10 characters contain the library name. You can use these special values for the library name:
| *CURLIB | The job's current library |
| *LIBL | The library list |
The content and format of the list returned. The possible format name is:
| PPPJ0100 | Each entry in the list contains information about a point-to-point job associated with the specified point-to-point connection profile name. The specified profile must be active for job information to be returned. If the specified profile is not active, an empty list will be returned. |
See Format of Point-to-Point Jobs List for a description of the format.
The name of the point-to-point connection profile for which connection job information is being requested.
The structure in which to return error information. For the format of the structure, see Error Code Parameter.
The point-to-point jobs list consists of:
For details about the user area and generic header, see User Space Format for List APIs. For details about the remaining items, see the following sections. For detailed descriptions of the fields in the list returned, see Field Descriptions.
When you retrieve list entry information from a user space, you must use the entry size returned in the generic header. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid. For examples of how to process lists, see API examples.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name specified |
| 10 | A | CHAR(10) | User space library name specified |
| 20 | 14 | CHAR(8) | Format name specified |
| 28 | 1C | CHAR(10) | Point-to-point connection profile name specified |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | User space name used |
| 10 | A | CHAR(10) | User space library name used |
| 20 | 14 | CHAR(10) | Point-to-point connection profile name |
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | CHAR(10) | Job name |
| 10 | A | CHAR(10) | Job user name |
| 20 | 14 | CHAR(6) | Job number |
| 26 | 1A | CHAR(16) | Internal job identifier |
| 42 | 2A | CHAR(10) | Line name |
| 52 | 34 | BINARY(4) | Connection status |
| 56 | 38 | CHAR(15) | Local IP address |
| 71 | 47 | CHAR(15) | Remote IP address |
| 86 | 56 | CHAR(48) | Connected user name |
Connection status. The current status of the connection.
Connected user name. The name of the user who initiated the point-to-point connection. The user name is available only if authentication is enabled for the point-to-point connection profile; otherwise, *NONE will be returned.
Format name. The name of the format used to list the point-to-point connection jobs associated with an active point-to-point connection profile.
Internal job identifier. A value sent to other APIs to speed the process of locating the job on the system. The identifier is not valid following an initial program load (IPL). If you attempt to use it after an IPL, an exception occurs.
Job name. The simple job name of the point-to-point job.
Job number. The system-assigned job number of the point-to-point job.
Job user name. The user name under which the point-to-point job is running. This will be defined as QTCP for point-to-point connection profiles.
Line name. The name of the line associated with the point-to-point connection.
Local IP address. The IP address assigned to the local end of the point-to-point connection. The IP address is in dotted decimal format.
Point-to-point connection profile name. The name of the point-to-point connection profile for which connection job information is being requested.
Remote IP address. The IP address assigned to the remote end of the point-to-point connection. The IP address is in dotted decimal format.
User space library name. The name of the library containing the user space.
User space name. The user space used to return the list of point-to-point connection jobs associated with an active point-to-point connection profile.
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| TCP8211 E | Point-to-point profile &1 not found. |
| Top | Communications APIs | APIs by category |