friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
8826eae394
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QDCLCFGD.htm

1936 lines
51 KiB
HTML
Raw Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<!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>List Configuration Descriptions (QDCLCFGD) 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: -->
<!-- 040302 JAHARRIS Updated for CP8 line item -->
<!--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>List Configuration Descriptions (QDCLCFGD) API</h2>
<div class="box" style="width: 80%;">
&nbsp;&nbsp;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%">Qualified user space name</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">2</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">3</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">4</td>
<td align="left" valign="top">Object qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(40)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Status qualifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The List Configuration Descriptions (QDCLCFGD) API returns a list of
configuration descriptions. The list elements are all of one type (such as
line, controller, or device). The list contents can be further restricted by
one or more qualifiers, specified as parameters.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Configuration Description Authority</em></dt>
<dd>*USE</dd>
<dt><em>User Space Authority</em></dt>
<dd>*CHANGE</dd>
<dt><em>User Space Library Authority</em></dt>
<dd>*EXECUTE</dd>
</dl>
<p>(If one or more listed objects do not meet the authority requirement, they
will be omitted from the returned list. Only objects to which the user has
proper authority are in the list.)</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Qualified user space name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The user space that receives the information, and the library in which it is
located. The user must have read/write access to this space. The first 10
characters contain the user space name, and the second 10 characters contain
the library name.</p>
<p>You can use these special values for the library name:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*CURLIB</em></td>
<td align="left" valign="top">The job's current library</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LIBL</em></td>
<td align="left" valign="top">The library list</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the list returned. The possible format names
are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>CFGD0100</em></td>
<td align="left" valign="top">List of selected configuration descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>CFGD0200</em></td>
<td align="left" valign="top">List of selected configuration descriptions, plus
current status of each one</td>
</tr>
</table>
<p>See <a href="#HDRCFGDFMT">Format of Configuration Lists</a> for a
description of these formats.</p>
</dd>
<dt><strong>Configuration description type</strong></dt>
<dd>INPUT; CHAR(10)
<p>The type of configuration descriptions to be included in the list. The
possible description types are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LIND</em></td>
<td align="left" valign="top">Line descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CTLD</em></td>
<td align="left" valign="top">Controller descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DEVD</em></td>
<td align="left" valign="top">Device descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NWID</em></td>
<td align="left" valign="top">Network interface descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NWSD</em></td>
<td align="left" valign="top">Network server descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NTBD</em></td>
<td align="left" valign="top">NetBIOS descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*IPXD</em></td>
<td align="left" valign="top">Internetwork Packet Exchange (IPX)
descriptions</td>
</tr>
</table>
<br>
</dd>
<dt><a name="objqual"><strong>Object qualifier</strong></a></dt>
<dd>INPUT; CHAR(40)
<p>A restriction on the objects to be listed. If a qualifier is specified that
is inconsistent with the configuration description type parameter, an error
message is returned. A null list is returned if no configuration descriptions
meet the qualifications. If this parameter is set to all blanks, no object
qualification is performed. This parameter is divided into four 10-character
fields.</p>
<p>The primary qualifier value is placed in the first 10 characters of the
parameter. The allowable values are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>Object name</em></td>
<td align="left" valign="top">Object of this name only, of the specified
configuration description type</td>
</tr>
<tr>
<td align="left" valign="top"><em>Generic object name</em></td>
<td align="left" valign="top">All objects that have names matching the generic
string, of the specified configuration description type</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ALL</em></td>
<td align="left" valign="top">All objects of the specified configuration
description type</td>
</tr>
<tr>
<td align="left" valign="top"><em>*APPC</em></td>
<td align="left" valign="top">APPC controllers and devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ASP</em></td>
<td align="left" valign="top">Auxiliary storage pool devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ASYNC</em></td>
<td align="left" valign="top">Asynchronous lines, controllers, and devices
only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ATM</em></td>
<td align="left" valign="top">Asynchronous transfer mode network interfaces
only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*BSC</em></td>
<td align="left" valign="top">BSC lines, controllers, and devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CMN</em></td>
<td align="left" valign="top">Communications controllers or devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CRP</em></td>
<td align="left" valign="top">Cryptographic devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DDI</em></td>
<td align="left" valign="top">Distributed data interface lines only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DKT</em></td>
<td align="left" valign="top">Diskette devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DSP</em></td>
<td align="left" valign="top">Display devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ELAN</em></td>
<td align="left" valign="top">Ethernet lines only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FAX</em></td>
<td align="left" valign="top">Fax lines only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FNC</em></td>
<td align="left" valign="top">Finance controllers and devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*FR</em></td>
<td align="left" valign="top">Frame relay network interfaces and lines
only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*HOST</em></td>
<td align="left" valign="top">Host controllers and devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*IDLC</em></td>
<td align="left" valign="top">IDLC lines only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*INTRA</em></td>
<td align="left" valign="top">Intrasystem devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*ISDN</em></td>
<td align="left" valign="top">Integrated Services Digital Network (ISDN)
network interfaces only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LANPRT</em></td>
<td align="left" valign="top">LAN printer devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LCLDSP</em></td>
<td align="left" valign="top">Local display devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LCLPRT</em></td>
<td align="left" valign="top">Local printer devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LOC</em></td>
<td align="left" valign="top">Devices that match the specified remote location
name only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LWS</em></td>
<td align="left" valign="top">Local work station controllers only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*MLB</em></td>
<td align="left" valign="top">Media library devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NET</em></td>
<td align="left" valign="top">Network lines, controllers, or devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em><img src="delta.gif" alt="Start of change">*NWSH</em></td>
<td align="left" valign="top">Network server host adapter devices only<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="left" valign="top"><em>*OPT</em></td>
<td align="left" valign="top">Optical devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*OPTICAL</em></td>
<td align="left" valign="top">All optical devices and optical media library
devices (equivalent to *OPT plus *OPTMLB)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*OPTMLB</em></td>
<td align="left" valign="top">Optical media library devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PPP</em></td>
<td align="left" valign="top">Point-to-point lines only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*PRT</em></td>
<td align="left" valign="top">Printer devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RMTDSP</em></td>
<td align="left" valign="top">Remote display devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RMTPRT</em></td>
<td align="left" valign="top">Remote printer devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RSRC</em></td>
<td align="left" valign="top">Network interfaces, lines, controllers, or
devices that match the specified resource name only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RTL</em></td>
<td align="left" valign="top">Retail controllers and devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*RWS</em></td>
<td align="left" valign="top">Remote work station controllers only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SDLC</em></td>
<td align="left" valign="top">SDLC lines only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SNPT</em></td>
<td align="left" valign="top">SNPT devices and SNPT-class devices only
(SNPT-class devices include printer, display, finance, and retail devices)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SNUF</em></td>
<td align="left" valign="top">SNA upline facility devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*T1</em></td>
<td align="left" valign="top">Network interface of type T1.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*TAP</em></td>
<td align="left" valign="top">Tape devices and controllers only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*TAPE</em></td>
<td align="left" valign="top">All tape devices and tape media library devices
(equivalent to *TAP plus *TAPMLB)</td>
</tr>
<tr>
<td align="left" valign="top"><em>*TAPMLB</em></td>
<td align="left" valign="top">Tape media library devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*TDLC</em></td>
<td align="left" valign="top">TDLC lines only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*TRLAN</em></td>
<td align="left" valign="top">Token-ring lines only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*VWS</em></td>
<td align="left" valign="top">Virtual work station controllers only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*VRTDSP</em></td>
<td align="left" valign="top">Virtual display devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*VRTPRT</em></td>
<td align="left" valign="top">Virtual printer devices only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*WLS</em></td>
<td align="left" valign="top">Wireless lines only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*WS</em></td>
<td align="left" valign="top">Work station controllers only</td>
</tr>
<tr>
<td align="left" valign="top"><em>*X25</em></td>
<td align="left" valign="top">X.25 lines only</td>
</tr>
</table>
<p>The information in the following tables describes the requirements for the
first (primary qualifier), second, third, and fourth 10 characters of this
parameter.</p>
<table border cellpadding="5">
<tr>
<th align="left" valign="top">If...</th>
<th align="left" valign="top">Then...</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Configuration description type
parameter is *NWSD and the primary qualifier equals an object name</td>
<td align="left" valign="top" width="50%">The last 2 characters of the
10-character primary qualifier must be blanks</td>
</tr>
<tr>
<td align="left" valign="top" colspan="2"><strong>Note:</strong> This is
because network server names can only be up to 8 characters.</td>
</tr>
</table>
<br>
<br>
<table border cellpadding="5">
<tr>
<th align="left" valign="top">If...</th>
<th align="left" valign="top">Then...</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Configuration description type
parameter is *NWSD</td>
<td align="left" valign="top" width="50%">Primary qualifier must be specified
as only *ALL, *RSRC, or an object name</td>
</tr>
<tr>
<td align="left" valign="top">Configuration description type parameter is
*NTBD</td>
<td align="left" valign="top">Primary qualifier must be specified as only *ALL
or an object name</td>
</tr>
<tr>
<td align="left" valign="top">Configuration description type parameter is
*IPXD</td>
<td align="left" valign="top">Primary qualifier must be specified as only *ALL
or an object name</td>
</tr>
</table>
<br>
<br>
<table border cellpadding="5">
<tr>
<th align="left" valign="top">If...</th>
<th align="left" valign="top">Then...</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Configuration description type
parameter is *DEVD and primary qualifier is *LOC</td>
<td align="left" valign="top" width="50%">Remote location name to be used is
placed in second 10 characters</td>
</tr>
<tr>
<td align="left" valign="top" colspan="2"><strong>Note:</strong> If a remote
location name is specified with any other combination of the configuration
description type parameter and primary qualifier, an error message is
returned.</td>
</tr>
</table>
<br>
<br>
<table border cellpadding="5">
<tr>
<th align="left" valign="top">If...</th>
<th align="left" valign="top">Then...</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Primary qualifier is *RSRC</td>
<td align="left" valign="top" width="50%">Resource name to be used is placed in
second 10 characters</td>
</tr>
<tr>
<td align="left" valign="top" colspan="2"><strong>Note:</strong> If a resource
name is specified with any other primary qualifier, an error message is
returned.</td>
</tr>
</table>
<br>
<br>
<table border cellpadding="5">
<tr>
<th align="left" valign="top">If...</th>
<th align="left" valign="top">Then...</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Configuration description type
parameter is *CTLD or *DEVD</td>
<td align="left" valign="top" width="50%">Type qualifier value may be placed in
third 10 characters</td>
</tr>
<tr>
<td align="left" valign="top" colspan="2"><strong>Note:</strong> If a type
qualifier is specified with any other value for the configuration description
type parameter, an error message is returned.
<p>A list of valid type values can be found in the
<a href="../books/sc415121.pdf" target="_blank">Local Device
Configuration</a><img src="wbpdf.gif" alt="Link to PDF"> book. If the type
value is not valid, a null list is returned.</p>
</td>
</tr>
</table>
<br>
<br>
<table border cellpadding="5">
<tr>
<th align="left" valign="top">If...</th>
<th align="left" valign="top">Then...</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Configuration description type
parameter is *CTLD or *DEVD and type qualifier is coded in third 10
characters</td>
<td align="left" valign="top" width="50%">Model qualifier value may be placed
in fourth 10 characters</td>
</tr>
<tr>
<td align="left" valign="top" colspan="2"><strong>Note:</strong> If a model
qualifier value is specified with any other value for the configuration
description type parameter or if the type qualifier is blank, an error message
is returned.
<p>A list of valid model values can be found in the
<a href="../books/sc415121.pdf" target="_blank">Local Device
Configuration</a><img src="wbpdf.gif" alt="Link to PDF"> book. If the model
value is not valid, a null list is returned.</p>
</td>
</tr>
</table>
<br>
</dd>
<dt><a name="statqual"><strong>Status qualifier</strong></a></dt>
<dd>INPUT; CHAR(20)
<p>A logical operator and a status value that are used to qualify which
configuration descriptions are included in the list. The first 10 bytes contain
a logical operator, left-justified. The valid values for the logical operator
are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*GT</em></td>
<td align="left" valign="top">Greater than</td>
</tr>
<tr>
<td align="left" valign="top"><em>*GE</em></td>
<td align="left" valign="top">Greater than, or equal to</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LT</em></td>
<td align="left" valign="top">Less than</td>
</tr>
<tr>
<td align="left" valign="top"><em>*LE</em></td>
<td align="left" valign="top">Less than, or equal to</td>
</tr>
<tr>
<td align="left" valign="top"><em>*EQ</em></td>
<td align="left" valign="top">Equal to</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NE</em></td>
<td align="left" valign="top">Not equal to</td>
</tr>
</table>
<p>The second 10 bytes contain a value denoting status, left-justified. The
allowed status values, in order of precedence, are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*ACTIVE</em></td>
<td align="left" valign="top">Object is active.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*VARYON</em></td>
<td align="left" valign="top">Object is varied on.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*VARYOFF</em></td>
<td align="left" valign="top">Object is varied off.</td>
</tr>
</table>
<p>The value in the second 10 bytes has an inherent hierarchy: *ACTIVE is
"greater than" *VARYON, and *VARYON is "greater than" *VARYOFF. The two values
are used together to form a logical qualifier. For example,
"*GE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*VARYON&nbsp;&nbsp;&nbsp; "
causes only objects that are active or varied on to be listed. Objects that are
currently varied off are excluded. Both values must be present if either is
present. An invalid logical qualifier results in a null list being returned.
This qualifier must be blank if the configuration description type parameter is
*NTBD or *IPXD.</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="HDRCFGDFMT">Format of Configuration Lists</a></h3>
<p>To request a list of configuration descriptions of a specific type, use
format CFGD0100. To request the current status for each description returned,
use format CFGD0200.</p>
<p>The configuration description list consists of:</p>
<ul>
<li>A user area</li>
<li>A generic header</li>
<li>An input parameter section</li>
<li>A header section</li>
<li>A list data section:
<ul>
<li>CFGD0100 format</li>
<li>CFGD0200 format</li>
</ul>
</li>
</ul>
<p>For details about the user area and generic header, see <a href="../apiref/usf.htm">
User Space Format for List APIs</a>. For details about the remaining items, see
the following sections. For detailed descriptions of the fields in the list
returned, see <a href="#HDRRETLSTD">Field Descriptions</a>.</p>
<p>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 the API <a href="../apiref/apiexmp.htm">
Examples</a>.</p>
<br>
<h3><a name="HDRMBRLIP1">Input Parameter Section</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="top" colspan="2">Offset</th>
<th align="left" valign="top" rowspan="2">Type</th>
<th align="left" valign="top" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="top">Dec</th>
<th align="center" valign="top">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(10)</td>
<td align="left" valign="top" width="60%">User space name specified</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User space library name specified</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Format name specified</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Configuration description type specified</td>
</tr>
<tr>
<td align="center" valign="top">38</td>
<td align="center" valign="top">26</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Object qualifier specified</td>
</tr>
<tr>
<td align="center" valign="top">78</td>
<td align="center" valign="top">4E</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Status qualifier specified</td>
</tr>
<tr>
<td align="center" valign="top">98</td>
<td align="center" valign="top">62</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRMBRLLH1">Header Section</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="top" colspan="2">Offset</th>
<th align="left" valign="top" rowspan="2">Type</th>
<th align="left" valign="top" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="top">Dec</th>
<th align="center" valign="top">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(10)</td>
<td align="left" valign="top" width="60%">Configuration description type
used</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(40)</td>
<td align="left" valign="top">Object qualifier used</td>
</tr>
<tr>
<td align="center" valign="top">50</td>
<td align="center" valign="top">32</td>
<td align="left" valign="top">CHAR(20)</td>
<td align="left" valign="top">Status qualifier used</td>
</tr>
<tr>
<td align="center" valign="top">70</td>
<td align="center" valign="top">46</td>
<td align="left" valign="top">CHAR(2)</td>
<td align="left" valign="top">Reserved</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="center" valign="top">48</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User space name used</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="center" valign="top">52</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User space library name used</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCFGD1">CFGD0100 Format</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="top" colspan="2">Offset</th>
<th align="left" valign="top" rowspan="2">Type</th>
<th align="left" valign="top" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="top">Dec</th>
<th align="center" valign="top">Hex</th>
</tr>
<tr>
<td align="center" valign="top" width="10%">0</td>
<td align="center" valign="top" width="10%">CHAR(10)</td>
<td align="left" valign="top" width="20%"></td>
<td align="left" valign="top" width="60%">Configuration description name</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="center" valign="top">A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Configuration description category</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Retrieve API format name</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Configuration description command suffix</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRCFGD2">CFGD0200 Format</a></h3>
<table border width="80%">
<tr>
<th align="center" valign="top" colspan="2">Offset</th>
<th align="left" valign="top" rowspan="2">Type</th>
<th align="left" valign="top" rowspan="2">Field</th>
</tr>
<tr>
<th align="center" valign="top">Dec</th>
<th align="center" valign="top">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%">Current status: numeric code</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="center" valign="top">4</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Configuration description name</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="center" valign="top">E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Configuration description category</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</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">44</td>
<td align="center" valign="top">2C</td>
<td align="left" valign="top">CHAR(50)</td>
<td align="left" valign="top">Text description</td>
</tr>
<tr>
<td align="center" valign="top">94</td>
<td align="center" valign="top">5E</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Job name</td>
</tr>
<tr>
<td align="center" valign="top">104</td>
<td align="center" valign="top">68</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">User name</td>
</tr>
<tr>
<td align="center" valign="top">114</td>
<td align="center" valign="top">72</td>
<td align="left" valign="top">CHAR(6)</td>
<td align="left" valign="top">Job number</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="center" valign="top">78</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">130</td>
<td align="center" valign="top">82</td>
<td align="left" valign="top">CHAR(8)</td>
<td align="left" valign="top">Retrieve API format name</td>
</tr>
<tr>
<td align="center" valign="top">138</td>
<td align="center" valign="top">8A</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Configuration description command suffix</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRETLSTD">Field Descriptions</a></h3>
<p><strong>Configuration description name.</strong> The name of an object
selected for inclusion in the list.</p>
<p><strong>Configuration description category.</strong> The value returned in
this field depends on the value specified for the configuration description
type parameter when the API was called, as follows:</p>
<ul>
<li><strong>Line description</strong>
<p>If the configuration description type parameter is *LIND (line description),
the value is one of the following.</p>
<p><strong>Note:</strong> The Retrieve Line Description (QDCRLIND) API can be
used to retrieve detailed information about the configuration description. Use
a format name shown in the following table as input when you call the QDCRLIND
API.</p>
<table border width="80%" cellpadding="3">
<tr>
<th align="left" valign="bottom">Line Description<br>
Category</th>
<th align="left" valign="bottom">Line Description<br>
API Format Name</th>
<th align="left" valign="bottom">Line Description<br>
Command Suffix</th>
</tr>
<tr>
<td align="left" valign="top" width="33%">*ASYNC</td>
<td align="left" valign="top" width="33%">LIND0300</td>
<td align="left" valign="top" width="33%">ASC</td>
</tr>
<tr>
<td align="left" valign="top">*BSC</td>
<td align="left" valign="top">LIND0400</td>
<td align="left" valign="top">BSC</td>
</tr>
<tr>
<td align="left" valign="top">*DDI</td>
<td align="left" valign="top">LIND1200</td>
<td align="left" valign="top">DDI</td>
</tr>
<tr>
<td align="left" valign="top">*ELAN</td>
<td align="left" valign="top">LIND0500</td>
<td align="left" valign="top">ETH</td>
</tr>
<tr>
<td align="left" valign="top">*FAX</td>
<td align="left" valign="top">LIND1400</td>
<td align="left" valign="top">FAX</td>
</tr>
<tr>
<td align="left" valign="top">*FR</td>
<td align="left" valign="top">LIND1300</td>
<td align="left" valign="top">FR</td>
</tr>
<tr>
<td align="left" valign="top">*IDLC</td>
<td align="left" valign="top">LIND0600</td>
<td align="left" valign="top">IDLC</td>
</tr>
<tr>
<td align="left" valign="top">*NET</td>
<td align="left" valign="top">LIND0700</td>
<td align="left" valign="top">NET</td>
</tr>
<tr>
<td align="left" valign="top">*PPP</td>
<td align="left" valign="top">LIND1600</td>
<td align="left" valign="top">PPP</td>
</tr>
<tr>
<td align="left" valign="top">*SDLC</td>
<td align="left" valign="top">LIND0800</td>
<td align="left" valign="top">SDLC</td>
</tr>
<tr>
<td align="left" valign="top">*TDLC</td>
<td align="left" valign="top">LIND0900</td>
<td align="left" valign="top">TDLC</td>
</tr>
<tr>
<td align="left" valign="top">*TRLAN</td>
<td align="left" valign="top">LIND1000</td>
<td align="left" valign="top">TRN</td>
</tr>
<tr>
<td align="left" valign="top">*WLS</td>
<td align="left" valign="top">LIND1500</td>
<td align="left" valign="top">WLS</td>
</tr>
<tr>
<td align="left" valign="top">*X25</td>
<td align="left" valign="top">LIND1100</td>
<td align="left" valign="top">X25</td>
</tr>
</table>
<br>
<br>
</li>
<li><strong>Controller description</strong>
<p>If the configuration description type parameter is *CTLD (controller
description), the value is one of the following:</p>
<p><strong>Note:</strong> The Retrieve Controller Description (QDCRCTLD) API
can be used to retrieve detailed information about the configuration
description. Use a format name shown in the following table as input when you
call the QDCRCTLD API.</p>
<table border width="80%" cellpadding="3">
<tr>
<th align="left" valign="bottom">Controller<br>
Description Category</th>
<th align="left" valign="bottom">Controller Description<br>
API Format Name</th>
<th align="left" valign="bottom">Controller Description<br>
Command Suffix</th>
</tr>
<tr>
<td align="left" valign="top" width="33%">*APPC</td>
<td align="left" valign="top" width="33%">CTLD0300</td>
<td align="left" valign="top" width="33%">APPC</td>
</tr>
<tr>
<td align="left" valign="top">*ASYNC</td>
<td align="left" valign="top">CTLD0400</td>
<td align="left" valign="top">ASC</td>
</tr>
<tr>
<td align="left" valign="top">*BSC</td>
<td align="left" valign="top">CTLD0500</td>
<td align="left" valign="top">BSC</td>
</tr>
<tr>
<td align="left" valign="top">*FNC</td>
<td align="left" valign="top">CTLD0600</td>
<td align="left" valign="top">FNC</td>
</tr>
<tr>
<td align="left" valign="top">*HOST</td>
<td align="left" valign="top">CTLD0700</td>
<td align="left" valign="top">HOST</td>
</tr>
<tr>
<td align="left" valign="top">*LWS</td>
<td align="left" valign="top">CTLD1200</td>
<td align="left" valign="top">LWS</td>
</tr>
<tr>
<td align="left" valign="top">*NET</td>
<td align="left" valign="top">CTLD0800</td>
<td align="left" valign="top">NET</td>
</tr>
<tr>
<td align="left" valign="top">*RTL</td>
<td align="left" valign="top">CTLD0900</td>
<td align="left" valign="top">RTL</td>
</tr>
<tr>
<td align="left" valign="top">*RWS</td>
<td align="left" valign="top">CTLD1000</td>
<td align="left" valign="top">RWS</td>
</tr>
<tr>
<td align="left" valign="top">*TAP</td>
<td align="left" valign="top">CTLD1300</td>
<td align="left" valign="top">TAP</td>
</tr>
<tr>
<td align="left" valign="top">*VWS</td>
<td align="left" valign="top">CTLD1100</td>
<td align="left" valign="top">VWS</td>
</tr>
<tr>
<td align="left" valign="top">A specific controller type value</td>
<td align="left" valign="top">Appropriate format</td>
<td align="left" valign="top">Appropriate suffix</td>
</tr>
</table>
<br>
<br>
</li>
<li><strong>Device description</strong>
<p>If the configuration description type parameter is *DEVD (device
description), the value is one of the following.</p>
<p><strong>Note:</strong> The Retrieve Device Description (QDCRDEVD) API can be
used to retrieve detailed information about the configuration description. Use
a format name shown in the following table as input when you call the QDCRDEVD
API.</p>
<table border width="80%" cellpadding="3">
<tr>
<th align="left" valign="bottom">Device<br>
Description Category</th>
<th align="left" valign="bottom">Device Description<br>
API Format Name</th>
<th align="left" valign="bottom">Device Description<br>
Command Suffix</th>
</tr>
<tr>
<td align="left" valign="top" width="33%">*APPC</td>
<td align="left" valign="top" width="33%">DEVD0200</td>
<td align="left" valign="top" width="33%">APPC</td>
</tr>
<tr>
<td align="left" valign="top">*ASP</td>
<td align="left" valign="top">DEVD1900</td>
<td align="left" valign="top">ASP</td>
</tr>
<tr>
<td align="left" valign="top">*ASYNC</td>
<td align="left" valign="top">DEVD0300</td>
<td align="left" valign="top">ASC</td>
</tr>
<tr>
<td align="left" valign="top">*BSC</td>
<td align="left" valign="top">DEVD0400</td>
<td align="left" valign="top">BSC</td>
</tr>
<tr>
<td align="left" valign="top">*CRP</td>
<td align="left" valign="top">DEVD1800</td>
<td align="left" valign="top">CRP</td>
</tr>
<tr>
<td align="left" valign="top">*DKT</td>
<td align="left" valign="top">DEVD0500</td>
<td align="left" valign="top">DKT</td>
</tr>
<tr>
<td align="left" valign="top">*DSP</td>
<td align="left" valign="top">DEVD0600</td>
<td align="left" valign="top">DSP</td>
</tr>
<tr>
<td align="left" valign="top">*FNC</td>
<td align="left" valign="top">DEVD0700</td>
<td align="left" valign="top">FNC</td>
</tr>
<tr>
<td align="left" valign="top">*HOST</td>
<td align="left" valign="top">DEVD0800</td>
<td align="left" valign="top">HOST</td>
</tr>
<tr>
<td align="left" valign="top">*INTR</td>
<td align="left" valign="top">DEVD0900</td>
<td align="left" valign="top">INTR</td>
</tr>
<tr>
<td align="left" valign="top">*MLB</td>
<td align="left" valign="top">DEVD1700</td>
<td align="left" valign="top">MLB</td>
</tr>
<tr>
<td align="left" valign="top">*NET</td>
<td align="left" valign="top">DEVD1000</td>
<td align="left" valign="top">NET</td>
</tr>
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">*NWSH</td>
<td align="left" valign="top">DEVD2000</td>
<td align="left" valign="top">NWSH<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="left" valign="top">*OPT</td>
<td align="left" valign="top">DEVD1600</td>
<td align="left" valign="top">OPT</td>
</tr>
<tr>
<td align="left" valign="top">*OPTMLB</td>
<td align="left" valign="top">DEVD1700</td>
<td align="left" valign="top">MLB</td>
</tr>
<tr>
<td align="left" valign="top">*PRT</td>
<td align="left" valign="top">DEVD1100</td>
<td align="left" valign="top">PRT</td>
</tr>
<tr>
<td align="left" valign="top">*RTL</td>
<td align="left" valign="top">DEVD1200</td>
<td align="left" valign="top">RTL</td>
</tr>
<tr>
<td align="left" valign="top">*SNPT</td>
<td align="left" valign="top">DEVD1300</td>
<td align="left" valign="top">SNPT</td>
</tr>
<tr>
<td align="left" valign="top">*SNUF</td>
<td align="left" valign="top">DEVD1400</td>
<td align="left" valign="top">SNUF</td>
</tr>
<tr>
<td align="left" valign="top">*TAP</td>
<td align="left" valign="top">DEVD1500</td>
<td align="left" valign="top">TAP</td>
</tr>
<tr>
<td align="left" valign="top">*TAPMLB</td>
<td align="left" valign="top">DEVD1700</td>
<td align="left" valign="top">MLB</td>
</tr>
<tr>
<td align="left" valign="top">A specific device type value</td>
<td align="left" valign="top">Appropriate format</td>
<td align="left" valign="top">Appropriate suffix</td>
</tr>
</table>
<br>
<br>
</li>
<li><strong>Network interface description</strong>
<p>If the configuration description type parameter is *NWID (network interface
description), the value is one of the following:</p>
<p><strong>Note:</strong> There is no API available to retrieve network
interface descriptions. Therefore, the API format name is set to blanks and is
not included in the following table.</p>
<table border width="80%" cellpadding="3">
<tr>
<th align="left" valign="bottom">Network Interface<br>
Description Category</th>
<th align="left" valign="bottom">Network Interface<br>
Description Command Suffix</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">*ATM</td>
<td align="left" valign="top" width="50%">ATM</td>
</tr>
<tr>
<td align="left" valign="top">*FR</td>
<td align="left" valign="top">FR</td>
</tr>
<tr>
<td align="left" valign="top">*ISDN</td>
<td align="left" valign="top">ISDN</td>
</tr>
<tr>
<td align="left" valign="top">*T1</td>
<td align="left" valign="top">T1</td>
</tr>
</table>
<br>
<br>
</li>
<li><strong>Network server description</strong>
<p>If the configuration description type parameter is *NWSD (network server
description), the value is one of the following:</p>
<p><strong>Note:</strong> The Retrieve Network Server Description (QDCRNWSD)
API can be used to retrieve detailed information about the configuration
description. Use a format name shown in the following table as input when you
call the QDCRNWSD API. The command suffix is set to blanks.</p>
<table border width="80%" cellpadding="3">
<tr>
<th align="left" valign="bottom">Network Server<br>
Description Category</th>
<th align="left" valign="bottom">Network Server Description<br>
API Format Name</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">*AIX</td>
<td align="left" valign="top" width="50%">NWSD0500</td>
</tr>
<tr>
<td align="left" valign="top">*BASE</td>
<td align="left" valign="top">NWSD0400</td>
</tr>
<tr>
<td align="left" valign="top">*GUEST</td>
<td align="left" valign="top">NWSD0700</td>
</tr>
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">*ISCSI</td>
<td align="left" valign="top">NWSD0800<img src="deltaend.gif" alt="End of change"></td>
</tr>
<tr>
<td align="left" valign="top">*LANSERVER</td>
<td align="left" valign="top">NWSD0200</td>
</tr>
<tr>
<td align="left" valign="top">*NETWARE</td>
<td align="left" valign="top">NWSD0300</td>
</tr>
<tr>
<td align="left" valign="top"><img src="delta.gif" alt="Start of change">*WINDOWSNT, *IXSVR</td>
<td align="left" valign="top">NWSD0600<img src="deltaend.gif" alt="End of change"></td>
</tr>
</table>
<br>
<br>
</li>
</ul>
<p><strong>Note:</strong> The category values are derived from the command that
is used to create the configuration description.</p>
<p><strong>Configuration description command suffix.</strong> The configuration
description command suffix consists of the last characters (up to 4) that are
associated with the create and change command for the configuration description
types.</p>
<p><strong>Note:</strong> For the format name values, see the tables defined
for the configuration description category field.</p>
<p><strong>Configuration description type specified.</strong> The value
specified for the type of configuration description to be included in the
list.</p>
<p>The possible types are:</p>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>*LIND</em></td>
<td align="left" valign="top">Line descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CTLD</em></td>
<td align="left" valign="top">Controller descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*DEVD</em></td>
<td align="left" valign="top">Device descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NWID</em></td>
<td align="left" valign="top">Network interface descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NWSD</em></td>
<td align="left" valign="top">Network server descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NTBD</em></td>
<td align="left" valign="top">NetBIOS descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>*IPXD</em></td>
<td align="left" valign="top">Internetwork Packet Exchange (IPX)
descriptions</td>
</tr>
</table>
<p><strong>Configuration description type used.</strong> The type of
configuration description included in the list.</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 will be returned translated.
This text is retrieved from message CPX2651 in message file QCPFMSG in *LIBL.
If the job CCSID, message file
CCSID, or message description CCSID is 65535 the displayable text is returned
in the CCSID of the message description and not in the CCSID found in the
generic header of the user space.
The value is one of the following:</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">5</td>
<td align="left" valign="top">AS/36 DISABLED</td>
</tr>
<tr>
<td align="center" valign="top"><img src="delta.gif" alt="Start of change">10</td>
<td align="left" valign="top">VARY OFF PENDING<img src="deltaend.gif" alt="End of change"></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">30</td>
<td align="left" valign="top">VARIED ON</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">60</td>
<td align="left" valign="top">ACTIVE</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="left" valign="top">AS/36 ENABLED</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">66</td>
<td align="left" valign="top">ACTIVE WRITER</td>
</tr>
<tr>
<td align="center" valign="top">70</td>
<td align="left" valign="top">HELD</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">90</td>
<td align="left" valign="top">RCYCNL</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">103</td>
<td align="left" valign="top">FAILED READER</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>Format name specified.</strong> The name specified for the format to
be used in generating the list. The possible formats are:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>CFGD0100</em></td>
<td align="left" valign="top">List of selected configuration descriptions</td>
</tr>
<tr>
<td align="left" valign="top"><em>CFGD0200</em></td>
<td align="left" valign="top">List of selected configuration descriptions, plus
current status of each one</td>
</tr>
</table>
<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>Object qualifier specified.</strong> The qualifier values specified
that define which objects are to be included in the generated list. See the <a
href="#objqual">object qualifier</a> parameter in the Required Parameter Group
for details on the possible values.</p>
<p><strong>Object qualifier used.</strong> The qualifier values used to
determine which objects are included in the list.</p>
<p><strong>Pass-through device.</strong> The name of an upstream device used to
complete a pass-through session, if applicable. This field is only filled in
for SNA pass-through devices. These devices are created using the Create Device
Description (SNA Pass-Through) (CRTDEVSNPT) command. If an SNA pass-through
device does not exist, the field is blank.</p>
<p><strong>Reserved.</strong> Space included for alignment.</p>
<p><strong>Retrieve API format name.</strong> The format name that is used to
retrieve detailed information about a configuration description by using a
retrieve API. The following are the available APIs:</p>
<p><a name="QDCRLIND.htm">Retrieve Line Description (QDCRLIND)</a><br>
<a name="QDCRCTLD.htm">Retrieve Controller Description (QDCRCTLD)</a><br>
<a name="QDCRDEVD.htm">Retrieve Device Description (QDCRDEVD)</a><br>
<a name="QDCRNWSD.htm">Retrieve Network Server Description (QDCRNWSD)</a></p>
<p><strong>Note:</strong> This field is filled in only for configuration
description categories of *LIND, *CTLD, *DEVD, and *NWSD. For the format name
values, see the tables defined for the configuration description category
field.</p>
<p><strong>Status qualifier specified.</strong> The status values specified
that define which configuration descriptions are to be included in the
generated list. See the <a href="#statqual">status qualifier</a> parameter in
the Required Parameter Group for details on the possible values.</p>
<p><strong>Status qualifier used.</strong> The status values used to determine
which configuration descriptions are included in the list.</p>
<p><strong>Text description.</strong> The text that describes the selected
object.</p>
<p><strong>User name.</strong> The user name portion of a fully qualified job
name.</p>
<p><strong>User space library name specified.</strong> The name specified for
the library that contains the user space to receive the generated list.</p>
<p><strong>User space library name used.</strong> The actual name of the
library used to contain the user space that received the list.</p>
<p><strong>User space name specified.</strong> The name specified for the user
space that is to receive the generated list.</p>
<p><strong>User space name used.</strong> The actual name of the user space
that received the list.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<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">CPF26A8 E</td>
<td align="left" valign="top">Configuration description type not valid for this
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF26A9 E</td>
<td align="left" valign="top">Object qualifier not valid for this API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF26AA E</td>
<td align="left" valign="top">Status qualifier not valid for this API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td align="left" valign="top">Format name &amp;1 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">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;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>
Reference in New Issue Copy Permalink