223 lines
6.4 KiB
HTML
223 lines
6.4 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
||
|
|
<title>Disable Link (QOLDLINK) API</title>
|
||
|
|
<!-- Begin Header Records ========================================== -->
|
||
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
||
|
|
<!-- US Government Users Restricted Rights -->
|
||
|
|
<!-- Use, duplication or disclosure restricted by -->
|
||
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
||
|
|
<!-- Print SCRIPT A converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
||
|
|
<!-- at RCHVMW2 on 17 Feb 1999 at 11:05:09 -->
|
||
|
|
<!-- This file has undergone html cleanup June 2002 by JET -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!--File Edited November 2001 -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
<!--Java sync-link -->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<h2>Disable Link (QOLDLINK) API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
Required Parameter Group:<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">1</td>
|
||
|
|
<td align="left" valign="top" width="50%">Return code</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Reason code</td>
|
||
|
|
<td align="left" valign="top">Output</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Communications handle</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(10)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Vary option</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(1)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: No<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>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.</p>
|
||
|
|
|
||
|
|
<p>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:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li>When the network device associated with an enabled link is varied off from
|
||
|
|
the job in which it was enabled<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>When a job ends in which one or more links were enabled<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>When the application program that enabled the link ends abnormally<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>When the Reclaim Resource (RCLRSC) command is used<br>
|
||
|
|
<br>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>When an unmonitored escape message is received</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<p>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
|
||
|
|
<a href="comm3.htm#HDRDCPLTEN">Disable-Complete Entry</a> for the format of the
|
||
|
|
disable-complete entry.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
|
||
|
|
<!-- Instead, use the commented out coding below to indicate NONE. -->
|
||
|
|
<h3>Authorities and Locks</h3>
|
||
|
|
|
||
|
|
<!-- Use this if there are no authorities and locks. -->
|
||
|
|
<p>None.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="Header_4">Required Parameter Group</a></h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Return code</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The recovery action to take. See <a href="#HDRDLINKRR">Return and Reason
|
||
|
|
Codes</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Reason code</strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The error that occurred. See <a href="#HDRDLINKRR">Return and Reason
|
||
|
|
Codes</a>.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Communications handle</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(10)
|
||
|
|
|
||
|
|
<p>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.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Vary option</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(1)
|
||
|
|
|
||
|
|
<p>The vary option for the network device description associated with each link
|
||
|
|
being disabled. The valid values are as follows:</p>
|
||
|
|
|
||
|
|
<table cellpadding="3">
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>X'00'</em></td>
|
||
|
|
<td valign="top">Do not vary off the network device description.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top"><em>X'01'</em></td>
|
||
|
|
<td valign="top">Vary off the network device description.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="HDRDLINKRR">Return and Reason Codes</a></h3>
|
||
|
|
|
||
|
|
<p><strong><a name="TBLRR4">Return and Reason Codes for the QOLDLINK
|
||
|
|
API</a></strong></p>
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th valign="top">Return / Reason Code</th>
|
||
|
|
<th valign="top">Meaning</th>
|
||
|
|
<th valign="top">Recovery</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="30%">0/0</td>
|
||
|
|
<td align="left" valign="top" width="30%">Operation successful.</td>
|
||
|
|
<td align="left" valign="top" width="40%">Continue processing.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="30%">83/1004</td>
|
||
|
|
<td align="left" valign="top" width="30%">Vary option not valid.</td>
|
||
|
|
<td align="left" valign="top" width="40%">Correct the vary option parameter.
|
||
|
|
Then, try the request again.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="30%">83/3001</td>
|
||
|
|
<td align="left" valign="top" width="30%">Link not enabled.</td>
|
||
|
|
<td align="left" valign="top" width="40%">Correct the communications handle
|
||
|
|
parameter. Then, try the request again.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V2R1
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"comm.htm">Communications APIs</a> | <a href="aplist.htm">APIs by
|
||
|
|
category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|