618 lines
17 KiB
HTML
618 lines
17 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>OPM/ILE Template for APIs (OPM Name, ILE Name)</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. -->
|
||
|
|
<!-- Created for V5R4 on 041119 by cmwood -->
|
||
|
|
<!-- Change history: -->
|
||
|
|
<!-- 041119 CMWOOD New API -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Java sync-link -->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
|
||
|
|
<h2><img src="delta.gif" alt="Start of change">Convert Interface ID (QtocCvtIfcID)
|
||
|
|
API</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 90%;">
|
||
|
|
<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%">Receiver variable</td>
|
||
|
|
<td align="left" valign="top" width="20%">Output</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">Length of receiver variable</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">3</td>
|
||
|
|
<td align="left" valign="top">Format name</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(8)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">Interface request</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">5</td>
|
||
|
|
<td align="left" valign="top">Interface request CCSID</td>
|
||
|
|
<td align="left" valign="top">Input</td>
|
||
|
|
<td align="left" valign="top">Binary(4)</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top">6</td>
|
||
|
|
<td align="left" valign="top">Error Code</td>
|
||
|
|
<td align="left" valign="top">I/O</td>
|
||
|
|
<td align="left" valign="top">Char(*)</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
Service Program Name: QTOCNETSTS<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Default Public Authority: *USE<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
Threadsafe: Yes<br>
|
||
|
|
<!-- iddvc RMBR -->
|
||
|
|
<br>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<p>The <strong>Convert Interface ID (QtocCvtIfcID)</strong> API retrieves the IP
|
||
|
|
address of an interface when given the name or the name of an interface when
|
||
|
|
given the IP address.</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>
|
||
|
|
|
||
|
|
<p>None.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Required Parameter Group</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Receiver variable </strong></dt>
|
||
|
|
|
||
|
|
<dd>OUTPUT; CHAR(*)
|
||
|
|
|
||
|
|
<p>The variable that is to receive the information requested. You can specify
|
||
|
|
the size of this area to be smaller than the format requested if you specify
|
||
|
|
the length of receiver variable parameter correctly. As a result, the API returns
|
||
|
|
only the data that the area can hold.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; BINARY(4)
|
||
|
|
|
||
|
|
<p>The length of the receiver variable. If this value is larger than the actual
|
||
|
|
size of the receiver variable, the result may not be predictable. The minimum
|
||
|
|
length is 8 bytes.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Format name</strong></dt>
|
||
|
|
|
||
|
|
<dd>INPUT; CHAR(8)
|
||
|
|
|
||
|
|
<p>The format of the information to be returned. The format names supported are:</p>
|
||
|
|
<dl>
|
||
|
|
<dt>NCII0100</dt>
|
||
|
|
<dd>Return the IP address associated with the name specified. Refer to <a href="#ncii0100">NCII0100
|
||
|
|
Format</a> for details on the format.</dd>
|
||
|
|
<dt>NCII0200</dt>
|
||
|
|
<dd>Return the name associated with the IPv4 address specified. Refer to <a href="#ncii0200">NCII0200
|
||
|
|
Format</a> for details on the format.</dd>
|
||
|
|
<dt>NCII0300</dt>
|
||
|
|
<dd>Return the name associated with the IPv6 address specified. Refer to <a href="#ncii0300">NCII0300
|
||
|
|
Format</a> for details on the format.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Interface request</strong></dt>
|
||
|
|
|
||
|
|
<dd>Input; CHAR(*)
|
||
|
|
|
||
|
|
<p>The alias name or interface IP address for the interface to retrieve the
|
||
|
|
mapping for. When format NCII0100 is used, the Interface request parameter must
|
||
|
|
be 50 characters long and the alias name must be passed in with this parameter.
|
||
|
|
When format NCII0200 is used, the Interface request parameter must be 15
|
||
|
|
characters long. When format NCII0300 is used, the data must be specified:
|
||
|
|
</p>
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="bottom">Dec</th>
|
||
|
|
<th align="left" valign="bottom">Hex</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(45)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Interface address</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">45</td>
|
||
|
|
<td align="center" valign="top" width="10%">2D</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(3)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">48</td>
|
||
|
|
<td align="center" valign="top" width="10%">30</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Line description</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">58</td>
|
||
|
|
<td align="center" valign="top" width="10%">3A</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(6)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<p>Field Descriptions</p>
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Interface address.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The IP address of the interface that is associated with the specified name.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Line description.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The physical line the interface is associated with. This field must be set
|
||
|
|
to all blanks when the interface is not a multi-cast interface.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Reserved.</strong></dt>
|
||
|
|
|
||
|
|
<dd>A reserved field. It must be x'00'.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Interface request CCSID</strong></dt>
|
||
|
|
|
||
|
|
<dd>Input; Binary(4)
|
||
|
|
|
||
|
|
<p>The coded character set ID for the Interface request. To specify the job CCSID,
|
||
|
|
this field should be set to 0. When using format NCII0200 or NCII0300, the
|
||
|
|
CCSID is not applicable and must be set to 0.</p>
|
||
|
|
<p><strong>Note:</strong> In V5R4, only the job CCSID is supported so this field
|
||
|
|
must always be set to 0.
|
||
|
|
</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Error code</strong></dt>
|
||
|
|
|
||
|
|
<dd>I/O; CHAR(*)
|
||
|
|
|
||
|
|
<p>The structure in which to return error information. For the format of the
|
||
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Format of Returned Interface Data</h3>
|
||
|
|
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3><a name="ncii0100">NCII0100 Format</a></h3>
|
||
|
|
|
||
|
|
<p>Format NCII0100 returns the IP address of the named interface. For detailed
|
||
|
|
descriptions of the fields in the table, see <a href="#FORMAT1">Field Descriptions</a></p>.
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="bottom">Dec</th>
|
||
|
|
<th align="left" valign="bottom">Hex</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Bytes returned</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">4</td>
|
||
|
|
<td align="center" valign="top" width="10%">4</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Bytes available</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">8</td>
|
||
|
|
<td align="center" valign="top" width="10%">8</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(45)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Interface address</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">53</td>
|
||
|
|
<td align="center" valign="top" width="10%">35</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(3)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">56</td>
|
||
|
|
<td align="center" valign="top" width="10%">38</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Line Description</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">66</td>
|
||
|
|
<td align="center" valign="top" width="10%">42</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(6)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="FORMAT1">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Bytes available.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The number of bytes of data available to be returned. All available data is
|
||
|
|
returned if enough space is provided.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Bytes returned.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The number of bytes of data returned.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Interface address.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The IP address of the interface that is associated with the specified name.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Line description.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The physical line the interface is associated with. This field is set
|
||
|
|
to all blanks when the interface is not a multi-cast interface.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Reserved.</strong></dt>
|
||
|
|
|
||
|
|
<dd>An ignored field.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="ncii0200">NCII0200 Format</a></h3>
|
||
|
|
|
||
|
|
<p>Format NCII0200 returns the name for the interface specified by the IP address. For detailed
|
||
|
|
descriptions of the fields in the table, see <a href="#FORMAT2">Field Descriptions</a></p>.
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="bottom">Dec</th>
|
||
|
|
<th align="left" valign="bottom">Hex</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Bytes returned</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">4</td>
|
||
|
|
<td align="center" valign="top" width="10%">4</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Bytes available</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">8</td>
|
||
|
|
<td align="center" valign="top" width="10%">8</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(50)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Alias name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">58</td>
|
||
|
|
<td align="center" valign="top" width="10%">3A</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(6)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">64</td>
|
||
|
|
<td align="center" valign="top" width="10%">40</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Alias name CCSID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="FORMAT2">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Alias name.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The name that is defined for the interface.
|
||
|
|
</dd>
|
||
|
|
<dt><strong>Alias name CCSID.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The coded character set ID of the alias name.
|
||
|
|
</dd>
|
||
|
|
<dt><strong>Bytes available.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The number of bytes of data available to be returned. All available data is
|
||
|
|
returned if enough space is provided.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Bytes returned.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The number of bytes of data returned.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Reserved.</strong></dt>
|
||
|
|
|
||
|
|
<dd>An ignored field.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3><a name="ncii0300">NCII0300 Format</a></h3>
|
||
|
|
|
||
|
|
<p>Format NCII0300 returns returns the name for the interface specified by the IP address. For detailed
|
||
|
|
descriptions of the fields in the table, see <a href="#FORMAT3">Field Descriptions</a></p>.
|
||
|
|
|
||
|
|
<table border width="80%">
|
||
|
|
<tr>
|
||
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
||
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="bottom">Dec</th>
|
||
|
|
<th align="left" valign="bottom">Hex</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="center" valign="top" width="10%">0</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Bytes returned</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">4</td>
|
||
|
|
<td align="center" valign="top" width="10%">4</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Bytes available</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">8</td>
|
||
|
|
<td align="center" valign="top" width="10%">8</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(50)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Alias name</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">58</td>
|
||
|
|
<td align="center" valign="top" width="10%">3A</td>
|
||
|
|
<td align="left" valign="top" width="20%">Char(6)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="center" valign="top" width="10%">64</td>
|
||
|
|
<td align="center" valign="top" width="10%">40</td>
|
||
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
||
|
|
<td align="left" valign="top" width="60%">Alias name CCSID</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="FORMAT3">Field Descriptions</a></h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong>Alias name.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The name that is defined for the interface.
|
||
|
|
</dd>
|
||
|
|
<dt><strong>Alias name CCSID.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The coded character set ID of the alias name.
|
||
|
|
</dd>
|
||
|
|
<dt><strong>Bytes available.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The number of bytes of data available to be returned. All available data is
|
||
|
|
returned if enough space is provided.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Bytes returned.</strong></dt>
|
||
|
|
|
||
|
|
<dd>The number of bytes of data returned.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong>Reserved.</strong></dt>
|
||
|
|
|
||
|
|
<dd>An ignored field.
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
<h3><a name="errmsg">Error Messages</a></h3>
|
||
|
|
|
||
|
|
<p>The following messages may be sent from this function:</p>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<th align="left" valign="top">Message ID</th>
|
||
|
|
<th align="left" valign="top">Error Message Text</th>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td width="15%" valign="top">TCP266B</td>
|
||
|
|
<td width="85%" valign="top">TCP/IP interface not found.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">TCP1901</td>
|
||
|
|
<td valign="top">Internet address &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">TCP1902</td>
|
||
|
|
<td valign="top">Internet address &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">TCP1908</td>
|
||
|
|
<td valign="top">Internet address &1 not valid.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">TCP84C6</td>
|
||
|
|
<td valign="top">Internal operations error - RESULT &1 CC &2 RC &3 ERRNO &4.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF24B4</td>
|
||
|
|
<td valign="top">Severe error while addressing parameter list.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C19</td>
|
||
|
|
<td valign="top">Error occurred with receiver variable specified.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C1E</td>
|
||
|
|
<td valign="top">Required parameter &1 omitted.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C21</td>
|
||
|
|
<td valign="top">Format name &1 is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C24</td>
|
||
|
|
<td valign="top">Length of the receiver variable is not valid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3C90</td>
|
||
|
|
<td valign="top">Literal value cannot be changed.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF1</td>
|
||
|
|
<td valign="top">Error code parameter not valid.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF3CF2</td>
|
||
|
|
<td valign="top">Error(s) occurred during running of &1 API.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF8100</td>
|
||
|
|
<td valign="top">All CPF81xx messages could be returned. xx is from 01 to FF.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top">CPF9872</td>
|
||
|
|
<td valign="top">Program or service program &1 in library &2 ended. Reason code &3.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<br>
|
||
|
|
<img src="deltaend.gif" alt="End of change">
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
API introduced: V5R4
|
||
|
|
|
||
|
|
<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>
|