Disable Link (QOLDLINK) API
Required Parameter Group:
| 1 | Return code | Output | Binary(4) |
| 2 | Reason code | Output | Binary(4) |
| 3 | Communications handle | Input | Char(10) |
| 4 | Vary option | Input | Char(1) |
Default Public Authority: *USE
Threadsafe: No
The Disable Link (QOLDLINK) API disables one or all links that are currently enabled in the job in which the application program is running. When a link is disabled, all system resources that the link is using are released, the input and output buffers and descriptors for that link are deleted, and input or output on that link is no longer possible.
In addition to an application program explicitly disabling a link by calling the QOLDLINK API, user-defined communications support will implicitly disable a link in the following cases:
- When the network device associated with an enabled link is varied off from
the job in which it was enabled
- When a job ends in which one or more links were enabled
- When the application program that enabled the link ends abnormally
- When the Reclaim Resource (RCLRSC) command is used
- When an unmonitored escape message is received
For each link that is successfully disabled, either explicitly or implicitly, the disable-complete entry will be sent to the data queue or user queue specified on the call to the QOLELINK API when the link was enabled. See Disable-Complete Entry for the format of the disable-complete entry.
Authorities and Locks
None.
Required Parameter Group
- Return code
- OUTPUT; BINARY(4)
The recovery action to take. See Return and Reason Codes.
- Reason code
- OUTPUT; BINARY(4)
The error that occurred. See Return and Reason Codes.
- Communications handle
- INPUT; CHAR(10)
The name of the link to disable. The special value of *ALL (left-justified and padded on the right with spaces) may be used to disable all links currently enabled in the job that the application program is running in.
- Vary option
- INPUT; CHAR(1)
The vary option for the network device description associated with each link being disabled. The valid values are as follows:
X'00' Do not vary off the network device description. X'01' Vary off the network device description.
Return and Reason Codes
Return and Reason Codes for the QOLDLINK API
| Return / Reason Code | Meaning | Recovery |
|---|---|---|
| 0/0 | Operation successful. | Continue processing. |
| 83/1004 | Vary option not valid. | Correct the vary option parameter. Then, try the request again. |
| 83/3001 | Link not enabled. | Correct the communications handle parameter. Then, try the request again. |
API introduced: V2R1