978 lines
25 KiB
HTML
978 lines
25 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>Retrieve Configuration Status (QDCRCFGS) 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. -->
|
|
<!-- Cnfg1 SCRIPT J converted by B2H R4.1 (346) (CMS) by V2KEA304 -->
|
|
<!-- at RCHVMW2 on 12 May 1999 at 12:05:09 -->
|
|
<!-- Change History: -->
|
|
<!-- 040301 JAHARRIS Add Status 114 - DEGRADED -->
|
|
<!-- File cleanup completed Sept 2001 by v2cdijab -->
|
|
<!-- 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>Retrieve Configuration Status (QDCRCFGS) API</h2>
|
|
|
|
<div class="box" style="width: 70%;">
|
|
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">Configuration description type</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Configuration description name</td>
|
|
<td align="left" valign="top">Input</td>
|
|
<td align="left" valign="top">Char(10)</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>
|
|
Default Public Authority: *USE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
<p>The Retrieve Configuration Status (QDCRCFGS) API retrieves the current
|
|
status of a line, controller, device, network interface, or network server
|
|
description.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>Configuration Description Authority</em></dt>
|
|
|
|
<dd>*USE</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Receiver variable</strong></dt>
|
|
|
|
<dd>OUTPUT; CHAR(*)
|
|
|
|
<p>The variable that is to receive the status information. Format CFGS0100
|
|
describes the layout of the status information returned in this variable.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Length of receiver variable</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The length of the area referenced by the receiver variable parameter. If the
|
|
amount of information to be returned is greater than this value, the
|
|
information is truncated to this length.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Format name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(8)
|
|
|
|
<p>The content and format of the status information returned for the specified
|
|
configuration description. The format name is:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>CFGS0100</em></td>
|
|
<td align="left" valign="top">Configuration description object status</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>See <a href="#HDRCFGSFMT">Format of Status Information</a> for a description
|
|
of this format.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Configuration description type</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The type of configuration description object for which status is being
|
|
retrieved. The possible values are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIND</em></td>
|
|
<td align="left" valign="top">The object is a line description.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CTLD</em></td>
|
|
<td align="left" valign="top">The object is a controller description.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*DEVD</em></td>
|
|
<td align="left" valign="top">The object is a device description.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NWID</em></td>
|
|
<td align="left" valign="top">The object is a network interface
|
|
description.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*NWSD</em></td>
|
|
<td align="left" valign="top">The object is a network server description.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Configuration description name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the line, controller, device or network interface for which
|
|
status is being retrieved.</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><a name="HDRCFGSFMT">Format of Status Information</a></h3>
|
|
|
|
<p>Following is the format of the status information returned. For detailed
|
|
descriptions of the fields in the list, see <a href="#HDRCFGSFLD">Field
|
|
Descriptions</a>.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRCFGS1">CFGS0100 Format</a></h3>
|
|
|
|
<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="center" valign="bottom">Dec</th>
|
|
<th align="center" 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">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Bytes available</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Current status: numeric code</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">CHAR(7)</td>
|
|
<td align="left" valign="top">Date information retrieved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">19</td>
|
|
<td align="center" valign="top">13</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Time information retrieved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">25</td>
|
|
<td align="center" valign="top">19</td>
|
|
<td align="left" valign="top">CHAR(20)</td>
|
|
<td align="left" valign="top">Current Status: displayable text</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">45</td>
|
|
<td align="center" valign="top">2D</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Job name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">55</td>
|
|
<td align="center" valign="top">37</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">User name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">65</td>
|
|
<td align="center" valign="top">41</td>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Job number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">71</td>
|
|
<td align="center" valign="top">47</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Pass-through device</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">81</td>
|
|
<td align="center" valign="top">51</td>
|
|
<td align="left" valign="top">CHAR(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="left" valign="top">BINARY (4)</td>
|
|
<td align="left" valign="top">Offset to list of active conversations</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="center" valign="top">58</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of active conversations</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">92</td>
|
|
<td align="center" valign="top">5C</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Entry length for list of active
|
|
conversations</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">96</td>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Offset to list of multiple job information</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Number of multiple jobs</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">104</td>
|
|
<td align="center" valign="top">68</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Entry length for list of multiple jobs</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="2" rowspan="6">These fields repeat for
|
|
each active conversation</td>
|
|
<td align="left" valign="top">BINARY(4)</td>
|
|
<td align="left" valign="top">Conversation status numeric value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(20)</td>
|
|
<td align="left" valign="top">Conversation status text value</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Conversation mode name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Conversation job name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Conversation user name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Conversation job number</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" colspan="2" rowspan="3">These fields repeat for
|
|
each additional job</td>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Multiple job name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(10)</td>
|
|
<td align="left" valign="top">Multiple job user name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CHAR(6)</td>
|
|
<td align="left" valign="top">Multiple job number</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="HDRCFGSFLD">Field Descriptions</a></h3>
|
|
|
|
<p><strong>Bytes available.</strong> The number of bytes of data available to
|
|
be returned. All available data is returned if enough space is provided.</p>
|
|
|
|
<p><strong>Bytes returned.</strong> The number of bytes of data returned.</p>
|
|
|
|
<p><strong>Conversation job name.</strong> The job name portion of the
|
|
qualified job name for an active conversation on an APPC device.</p>
|
|
|
|
<p><strong>Conversation job number.</strong> The job number portion of the
|
|
qualified job name for an active conversation on an APPC device.</p>
|
|
|
|
<p><strong>Conversation mode name.</strong> The mode name for an active
|
|
conversation on an APPC device.</p>
|
|
|
|
<p><strong>Conversation status numeric value.</strong> A numeric value that
|
|
represents the current status of an active conversation on an APPC device. See
|
|
the current status field for valid status values.</p>
|
|
|
|
<p><strong>Conversation status text value.</strong> A text value that
|
|
represents the current status of an active conversation on an APPC device. See
|
|
the current status field for valid status values.</p>
|
|
|
|
<p><strong>Conversation user name.</strong> The user name portion of the
|
|
qualified job name for an active conversation on an APPC device.</p>
|
|
|
|
<p><strong>Current status.</strong> The current status of the selected object
|
|
using two fields:</p>
|
|
|
|
<ul>
|
|
<li>Current status: numeric code</li>
|
|
|
|
<li>Current status: displayable text</li>
|
|
</ul>
|
|
|
|
<p><strong>Note:</strong> The displayable text is translated when it is
|
|
returned. This text is retrieved from message CPX2651 in message file QCPFMSG
|
|
in library *LIBL.</p>
|
|
|
|
<p>Possible values follow:</p>
|
|
|
|
<table width="80%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="center" valign="top">Status Numeric<br>
|
|
Code (decimal)</th>
|
|
<th align="left" valign="top">Status Displayable Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">0</td>
|
|
<td align="left" valign="top">VARIED OFF</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">1</td>
|
|
<td align="left" valign="top">OPERATIONAL</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">AS/36 DISABLED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">DEALLOCATED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">UNPROTECTED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">ALLOCATED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">STAND-ALONE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">VARY OFF PENDING</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">VARY ON PENDING</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">21</td>
|
|
<td align="left" valign="top">VARY ON PENDING/DETACHED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">22</td>
|
|
<td align="left" valign="top">VARY ON PENDING/ALLOCATE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">30</td>
|
|
<td align="left" valign="top">VARIED ON</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">31</td>
|
|
<td align="left" valign="top">VARIED ON/ALLOCATE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="left" valign="top">VARYON/CNNPENDING</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">33</td>
|
|
<td align="left" valign="top">AS/36 ENABLED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">40</td>
|
|
<td align="left" valign="top">CONNECT PENDING</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="left" valign="top">SIGNON DISPLAY</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">51</td>
|
|
<td align="left" valign="top">ACTIVE/CNN PENDING</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="left" valign="top">ACTIVE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">61</td>
|
|
<td align="left" valign="top">ACTIVE/DETACHED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">62</td>
|
|
<td align="left" valign="top">ACTIVE/SOURCE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">63</td>
|
|
<td align="left" valign="top">ACTIVE READER</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">ACTIVE/TARGET</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">65</td>
|
|
<td align="left" valign="top">ACTIVE/ALLOCATE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">66</td>
|
|
<td align="left" valign="top">ACTIVE WRITER</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">67</td>
|
|
<td align="left" valign="top">AVAILABLE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">70</td>
|
|
<td align="left" valign="top">HELD</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">71</td>
|
|
<td align="left" valign="top">HELD/DETACHED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">72</td>
|
|
<td align="left" valign="top">HELD/SOURCE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">73</td>
|
|
<td align="left" valign="top">HELD/TARGET</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">74</td>
|
|
<td align="left" valign="top">HELD/ALLOCATE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">75</td>
|
|
<td align="left" valign="top">POWERED OFF</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="left" valign="top">RCYPND</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">81</td>
|
|
<td align="left" valign="top">RCYPND/DETACHED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">82</td>
|
|
<td align="left" valign="top">RCYPND/SOURCE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">83</td>
|
|
<td align="left" valign="top">RCYPND/TARGET</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="left" valign="top">RCYPND/ALLOCATE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">90</td>
|
|
<td align="left" valign="top">RCYCNL</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">91</td>
|
|
<td align="left" valign="top">RCYCNL/DETACHED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">92</td>
|
|
<td align="left" valign="top">RCYCNL/SOURCE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">93</td>
|
|
<td align="left" valign="top">RCYCNL/TARGET</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">94</td>
|
|
<td align="left" valign="top">RCYCNL/ALLOCATE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">95</td>
|
|
<td align="left" valign="top">SYSTEM REQUEST</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">96</td>
|
|
<td align="left" valign="top">REBUILD</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="left" valign="top">FAILED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">101</td>
|
|
<td align="left" valign="top">FAILED/DETACHED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">102</td>
|
|
<td align="left" valign="top">FAILED/SOURCE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">103</td>
|
|
<td align="left" valign="top">FAILED READER</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">104</td>
|
|
<td align="left" valign="top">FAILED/TARGET</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">105</td>
|
|
<td align="left" valign="top">FAILED/ALLOCATE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">106</td>
|
|
<td align="left" valign="top">FAILED WRITER</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">107</td>
|
|
<td align="left" valign="top">SHUTDOWN</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">110</td>
|
|
<td align="left" valign="top">DIAGNOSTIC MODE</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">111</td>
|
|
<td align="left" valign="top">*DAMAGED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">112</td>
|
|
<td align="left" valign="top">*LOCKED</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">113</td>
|
|
<td align="left" valign="top">*UNKNOWN</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">114</td>
|
|
<td align="left" valign="top">DEGRADED<img src="deltaend.gif" alt="End of change"></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">200</td>
|
|
<td align="left" valign="top">INVALID STATUS</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Date information retrieved.</strong> The date that the information
|
|
was provided by the API. This is returned as 7 characters in the form CYYMMDD,
|
|
where:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>C</em></td>
|
|
<td align="left" valign="top">Century, where 0 indicates years 19<em>xx</em>
|
|
and 1 indicates years 20<em>xx</em>.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>YY</em></td>
|
|
<td align="left" valign="top">Year</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>MM</em></td>
|
|
<td align="left" valign="top">Month</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>DD</em></td>
|
|
<td align="left" valign="top">Day</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Entry length for list of active conversations.</strong> The entry
|
|
length, in bytes, of each element in the list of active conversations returned
|
|
with this format. A value of zero is returned if the list is empty.</p>
|
|
|
|
<p><strong>Entry length for list of multiple jobs.</strong> The entry length,
|
|
in bytes, of each element in the list of multiple jobs returned with this
|
|
format. A value of zero is returned if the list is empty.</p>
|
|
|
|
<p><strong>Job name.</strong> The name of the job associated with an active
|
|
device, if applicable.</p>
|
|
|
|
<p><strong>Job number.</strong> The job number portion of a fully qualified job
|
|
name.</p>
|
|
|
|
<p><strong>Multiple job name.</strong> The job name portion of the qualified
|
|
job name for optical, media library, or network (*TEL type only) devices that
|
|
are being used by more than one job.</p>
|
|
|
|
<p><strong>Multiple job number.</strong> The job number portion of the
|
|
qualified job name for optical, media library, or network (*TEL type only)
|
|
devices that are being used by more than one job.</p>
|
|
|
|
<p><strong>Multiple job user name.</strong> The user name portion of the
|
|
qualified job name for optical, media library, or network (*TEL type only)
|
|
devices that are being used by more than one job.</p>
|
|
|
|
<p><strong>Number of active conversations.</strong> The number of entries in
|
|
the list of active conversations returned with this format. A value of zero is
|
|
returned if the list is empty.</p>
|
|
|
|
<p><strong>Number of multiple jobs.</strong> The number of entries in the list
|
|
of multiple jobs returned with this format. A value of zero is returned if the
|
|
list is empty.</p>
|
|
|
|
<p><strong>Offset to list of active conversations.</strong> The offset, in
|
|
bytes, to the list of active conversations returned with this format. A value
|
|
of zero is returned if the list is empty.</p>
|
|
|
|
<p><strong>Offset to list of multiple job information.</strong> The offset, in
|
|
bytes, to the list of multiple jobs returned with this format. A value of zero
|
|
is returned if the list is empty.</p>
|
|
|
|
<p><strong>Pass-through device.</strong> The name of an upstream device used to
|
|
complete a pass-through session, if applicable.</p>
|
|
|
|
<p><strong>Reserved.</strong> An ignored field.</p>
|
|
|
|
<p><strong>Time information retrieved.</strong> The time that the information
|
|
was provided by the API. It is returned as 6 characters in the form HHMMSS,
|
|
where:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>HH</em></td>
|
|
<td align="left" valign="top">Hour</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>MM</em></td>
|
|
<td align="left" valign="top">Minute</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>SS</em></td>
|
|
<td align="left" valign="top">Second</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>User name.</strong> The user name portion of a fully qualified job
|
|
name.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top" width="15%">CPF24B4 E</td>
|
|
<td align="left" valign="top" width="85%">Severe error while addressing
|
|
parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2625 E</td>
|
|
<td align="left" valign="top">Not able to allocate object &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2634 E</td>
|
|
<td align="left" valign="top">Not authorized to object &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF26A8 E</td>
|
|
<td align="left" valign="top">Configuration description type not valid for this
|
|
API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF26AE E</td>
|
|
<td align="left" valign="top">Network server description &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2702 E</td>
|
|
<td align="left" valign="top">Device description &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2703 E</td>
|
|
<td align="left" valign="top">Controller description &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF2704 E</td>
|
|
<td align="left" valign="top">Line description &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF27A4 E</td>
|
|
<td align="left" valign="top">Network interface description &1 not
|
|
found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C19 E</td>
|
|
<td align="left" valign="top">Error occurred with receiver variable
|
|
specified.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C21 E</td>
|
|
<td align="left" valign="top">Format name &1 is not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C24 E</td>
|
|
<td align="left" valign="top">Length of the receiver variable is not
|
|
valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C90 E</td>
|
|
<td align="left" valign="top">Literal value cannot be changed.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF8104 E</td>
|
|
<td align="left" valign="top">Controller description &4 damaged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF8105 E</td>
|
|
<td align="left" valign="top">Device description &4 damaged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF811D E</td>
|
|
<td align="left" valign="top">Network interface description &4
|
|
damaged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF8125 E</td>
|
|
<td align="left" valign="top">Line description &4 damaged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF814C E</td>
|
|
<td align="left" valign="top">Network server description &4 damaged.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9872 E</td>
|
|
<td align="left" valign="top">Program or service program &1 in library
|
|
&2 ended. Reason code &3.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<hr>
|
|
API introduced: V2R3
|
|
|
|
<hr>
|
|
<center>
|
|
<table cellpadding="2" cellspacing="2">
|
|
<tr align="center">
|
|
<td valign="middle" align="center">
|
|
<a href="#Top_Of_Page">Top</a> |
|
|
<a href="config.htm">Configuration APIs</a> |
|
|
<a href="aplist.htm">APIs by category</a></td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</body>
|
|
</html>
|
|
|