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

1992 lines
56 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>Retrieve Resource Information (QRZRRSI) 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. -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- This file has undergone html cleanup on 1/14/02 by JET -->
<!-- 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 Resource Information (QRZRRSI) API</h2>
<div class="box" style="width: 80%;">
<br>
&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%">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">Request criteria</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">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: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve Resource Information (QRZRRSI) API retrieves selected fields of
a hardware resource from a known resource name. The user of the API supplies
the resource name along with the request criteria by using key values. The
first or next information data that matches the request criteria from the
resource name supplied is returned.</p>
<p>Key values are used as a singular search criterion rather than as part of a
more complex search. The singular search criterion, by its nature, has very
concise results.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*EXCLUDE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The receiver variable that receives the information requested. You can
specify the size of the area to be smaller than the format requested as long as
you specify the length 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 provided. The length of receiver
variable parameter may be specified up to the size of the receiver variable
specified in the user program. If the length of receiver variable parameter
specified is larger than the allocated size of the receiver variable specified
in the user program, the results are not predictable. The minimum length is 8
bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The content and format of the information returned. The possible format name
is as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>RTVI0100</em></td>
<td align="left" valign="top">Returns the resource information from the
hardware resource name supplied and that matches the request criteria. See <a
href="#HDRRTVI10">RTVI0100 Format</a> for details about the format.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Request criteria</strong></dt>
<dd>INPUT; CHAR(*)
<p>The criteria for which the retrieve will be processed.</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="HDRRTVICRT">Format of the Request Criteria</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%">CHAR(32)</td>
<td align="left" valign="top" width="60%">Resource name</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(16)</td>
<td align="left" valign="top">Handle</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="center" valign="top">30</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Search request</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Offset to first key</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="center" valign="top">38</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Number of keys</td>
</tr>
<tr>
<td align="center" valign="top">&nbsp;</td>
<td align="center" valign="top">&nbsp;</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Keys</td>
</tr>
</table>
<br>
<br>
<h3><a name="FIELD1">Field Descriptions</a></h3>
<p><strong>Handle.</strong> The unique value that is obtained through the
Create Handle (QRZCRTH) API. The handle allows repeated calls to obtain more
than one resource name that meets the request criteria. The handle is created
through the Create Handle (QRZCRTH) API. The handle is required in conjunction
with the first or next search request. The handle must be set to binary zeros
in conjunction with the first search request when no next search request is
needed. The user is responsible for deleting the handle when it is no longer
needed. Use the Delete Handle (QRZDLTH) API to delete the handle.</p>
<p><strong><a name="keys">Keys.</a></strong> Following are the key values to be
used in the request criteria. For a description of the key and the values that
are valid for the key, see <a href="#KEYSFIELD">Key Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="top">Key</th>
<th align="left" valign="top">Field</th>
<th align="left" valign="top">Type</th>
</tr>
<tr>
<td align="center" valign="top" width="15%">2</td>
<td align="left" valign="top" width="60%">rvxCommunication flag</td>
<td align="left" valign="top" width="25%">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Type number</td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Serial number</td>
<td align="left" valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Model number</td>
<td align="left" valign="top">CHAR(3)</td>
</tr>
<tr>
<td align="center" valign="top">9</td>
<td align="left" valign="top">Reported this IPL flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">10</td>
<td align="left" valign="top">LAN flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">11</td>
<td align="left" valign="top">Vary-on wait time</td>
<td align="left" valign="top">BINARY(4)</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="left" valign="top">Bus number</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">14</td>
<td align="left" valign="top">Plant of manufacture number</td>
<td align="left" valign="top">CHAR(2)</td>
</tr>
<tr>
<td align="center" valign="top">15</td>
<td align="left" valign="top">Part number</td>
<td align="left" valign="top">CHAR(12)</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="left" valign="top">Emulating type</td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
<tr>
<td align="center" valign="top">17</td>
<td align="left" valign="top">Emulating model</td>
<td align="left" valign="top">CHAR(3)</td>
</tr>
<tr>
<td align="center" valign="top">19</td>
<td align="left" valign="top">Memory size</td>
<td align="left" valign="top">BINARY(4)</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="left" valign="top">Powered-on flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">21</td>
<td align="left" valign="top">Resource classification</td>
<td align="left" valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="center" valign="top">22</td>
<td align="left" valign="top">Operational flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">23</td>
<td align="left" valign="top">IOP has DASD flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="left" valign="top">Normal mode flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">25</td>
<td align="left" valign="top">Supplied data at IPL flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">26</td>
<td align="left" valign="top">DASD candidate flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="left" valign="top">Number of resources</td>
<td align="left" valign="top">BINARY(2)</td>
</tr>
<tr>
<td align="center" valign="top">31</td>
<td align="left" valign="top">Card number</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="left" valign="top">Board number</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">33</td>
<td align="left" valign="top">RCTT level</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">34</td>
<td align="left" valign="top">Card position</td>
<td align="left" valign="top">CHAR(5)</td>
</tr>
<tr>
<td align="center" valign="top">35</td>
<td align="left" valign="top">EIA (Electronics Industries Association)</td>
<td align="left" valign="top">CHAR(2)</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="left" valign="top">User location text</td>
<td align="left" valign="top">CHAR(40)</td>
</tr>
<tr>
<td align="center" valign="top">37</td>
<td align="left" valign="top">Frame ID</td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
<tr>
<td align="center" valign="top">38</td>
<td align="left" valign="top">Device position</td>
<td align="left" valign="top">CHAR(5)</td>
</tr>
<tr>
<td align="center" valign="top">44</td>
<td align="left" valign="top">Frame resource name</td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
<tr>
<td align="center" valign="top">45</td>
<td align="left" valign="top">Auxiliary processor</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="left" valign="top">Device address</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">47</td>
<td align="left" valign="top">Keyboard type</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">48</td>
<td align="left" valign="top">Color flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">51</td>
<td align="left" valign="top">Supported on system flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="left" valign="top">Controller description needed flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">53</td>
<td align="left" valign="top">Supports assign command flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">54</td>
<td align="left" valign="top">Wide screen flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">55</td>
<td align="left" valign="top">Programmable flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">56</td>
<td align="left" valign="top">Keyboard type extended</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">57</td>
<td align="left" valign="top">Console usage</td>
<td align="left" valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="center" valign="top">58</td>
<td align="left" valign="top">ASCII flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">59</td>
<td align="left" valign="top">High-speed digital flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">60</td>
<td align="left" valign="top">LAN speed</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="left" valign="top">V.24 interface flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">63</td>
<td align="left" valign="top">X.21 interface flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">64</td>
<td align="left" valign="top">V.35 interface flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">65</td>
<td align="left" valign="top">V.36 interface flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">67</td>
<td align="left" valign="top">Maximum lines attached</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="left" valign="top">Interface adapter card flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">69</td>
<td align="left" valign="top">DCE adapter card flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">70</td>
<td align="left" valign="top">Maximum ports attached</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">71</td>
<td align="left" valign="top">Maximum frame size</td>
<td align="left" valign="top">BINARY(2)</td>
</tr>
<tr>
<td align="center" valign="top">72</td>
<td align="left" valign="top">FAX communications flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">74</td>
<td align="left" valign="top">File server I/O processor flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">75</td>
<td align="left" valign="top">User configurable flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">76</td>
<td align="left" valign="top">Can backspace flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">77</td>
<td align="left" valign="top">Can overwrite flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">78</td>
<td align="left" valign="top">Supports tape write error recovery procedure
(TWERP) flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">
79</td>
<td align="left" valign="top">Library address</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">81</td>
<td align="left" valign="top">Transport type</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">82</td>
<td align="left" valign="top">UA type</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">83</td>
<td align="left" valign="top">Is daughter card flag</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">84</td>
<td align="left" valign="top">Contact data</td>
<td align="left" valign="top">CHAR(136)</td>
</tr>
<tr>
<td align="center" valign="top">86</td>
<td align="left" valign="top">Remote type</td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
<tr>
<td align="center" valign="top">87</td>
<td align="left" valign="top">Remote model</td>
<td align="left" valign="top">CHAR(3)</td>
</tr>
<tr>
<td align="center" valign="top">88</td>
<td align="left" valign="top">Remote serial</td>
<td align="left" valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="center" valign="top">89</td>
<td align="left" valign="top">Remote name</td>
<td align="left" valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="center" valign="top">90</td>
<td align="left" valign="top">Is an OEM</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">91</td>
<td align="left" valign="top">Is shared</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">119</td>
<td align="left" valign="top">Resource ID</td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
<tr>
<td align="center" valign="top">120</td>
<td align="left" valign="top">Write format</td>
<td align="left" valign="top">CHAR(2)</td>
</tr>
<tr>
<td align="center" valign="top">121</td>
<td align="left" valign="top">Read format</td>
<td align="left" valign="top">CHAR(2)</td>
</tr>
<tr>
<td align="center" valign="top">122</td>
<td align="left" valign="top">Media type</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">123</td>
<td align="left" valign="top">In library</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">124</td>
<td align="left" valign="top">Installed memory</td>
<td align="left" valign="top">BINARY(4)</td>
</tr>
<tr>
<td align="center" valign="top">125</td>
<td align="left" valign="top">Usable memory</td>
<td align="left" valign="top">BINARY(4)</td>
</tr>
<tr>
<td align="center" valign="top">126</td>
<td align="left" valign="top">Host type</td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
<tr>
<td align="center" valign="top">127</td>
<td align="left" valign="top">Host model</td>
<td align="left" valign="top">CHAR(3)</td>
</tr>
<tr>
<td align="center" valign="top">128</td>
<td align="left" valign="top">Host serial</td>
<td align="left" valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="center" valign="top">129</td>
<td align="left" valign="top">Host name</td>
<td align="left" valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="center" valign="top">130</td>
<td align="left" valign="top">Host this system</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">
146</td>
<td align="left" valign="top">I/O adapter address</td>
<td align="left" valign="top">CHAR(*)</td>
</tr>
<tr>
<td align="center" valign="top">150</td>
<td align="left" valign="top">Processor feature</td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
<tr>
<td align="center" valign="top">151</td>
<td align="left" valign="top">Interactive feature</td>
<td align="left" valign="top">CHAR(4)</td>
</tr>
<tr>
<td align="center" valign="top">152</td>
<td align="left" valign="top">Location Code Format</td>
<td align="left" valign="top">CHAR(1)</td>
</tr>
<tr>
<td align="center" valign="top">153</td>
<td align="left" valign="top">Location Code</td>
<td align="left" valign="top">CHAR(79)</td>
</tr>
</table>
<p><strong>Number of keys.</strong> The number of keys supplied in the keys
variable. One key per call is supported; multiple keys on one call are not
supported.</p>
<p><strong>Offset to first key.</strong> The offset from the start of the
structure to the first key.</p>
<p><strong>Resource name.</strong> The name of the resource from which the
retrieval is to be made. The resource name either is known or was obtained by
using another hardware resource API. <strong>Note:</strong> This field must
specify the CEC resource name when requesting resource information data for
either the Processor feature (key value 150),
the Interactive feature (key value 151) or the Location code format (key value 152).</p>
<p><strong>Search request.</strong> Whether the search request is a first
attempt or a next attempt.</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The first attempt to obtain resource information
from a possible list of resource information. This obtains the first list
entry.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The next attempt to obtain resource information
from a possible list of resource information. This obtains a subsequent list
entry if it exists.</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRTVI10">RTVI0100 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">Number of entries returned</td>
</tr>
<tr>
<td align="center" valign="top">12</td>
<td align="center" valign="top">C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of variable record</td>
</tr>
<tr>
<td align="center" valign="top">16</td>
<td align="center" valign="top">10</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Key</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Length of data</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Data</td>
</tr>
</table>
<br>
<br>
<h3><a name="FIELD1keys">Field Descriptions</a></h3>
<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><strong>Bytes returned.</strong> The number of bytes of data returned.</p>
<p><strong>Data.</strong> The data that is returned for the key.</p>
<p><strong>Key.</strong> The key for the data in this variable length record.
For a list of keys that can be returned in this field, see the <a href="#keys">
Keys</a> field description.</p>
<p><strong>Length of data.</strong> The length of the data portion of this
variable length record.</p>
<p><strong>Length of variable record.</strong> The length of the current
variable length record.</p>
<p><strong>Number of entries returned.</strong> The number of values returned
by the API.</p>
<br>
<h3><a name="KEYSFIELD">Key Field Descriptions</a></h3>
<strong>ASCII flag.</strong> Whether the resource is an American National
Standard Code for Information Exchange (ASCII) type. Valid values for this
field are 0 (No) and 1 (Yes).
<p><strong>Auxiliary processor.</strong> The address of the auxiliary
processor. The value for this field is returned as BINARY(2) and CHAR(4). Both
variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary
representation of the requested value, and CHAR(4) is the character
representation of the requested value. The order that the variables are put
into storage is binary first and then character.</p>
<p><strong>Board number.</strong> A numerical representation of a section of
the bus that the card is plugged into. The value for this field is returned as
BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same.
BINARY(2) is the binary representation of the requested value, and CHAR(4) is
the character representation of the requested value. The order that the
variables are put into storage is binary first and then character.</p>
<p><strong>Bus number.</strong> A numerical representation of the path
connection of the system processor to the card. The value for this field is
returned as BINARY(4) and CHAR(2). Both variables, BINARY(4) and CHAR(2), are
the same. BINARY(4) is the binary representation of the requested value, and
CHAR(2) is the character representation of the requested value. The order that
the variables are put into storage is binary first and then character.</p>
<p><strong>Can backspace flag.</strong> Whether the resource supports the
backspace operation. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Can overwrite flag.</strong> Whether the resource supports the
overwrite operation. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Card number.</strong> A numerical representation of the location of
the card on the bus. The value for this field is returned as BINARY(2) and
CHAR(4). Both variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the
binary representation of the requested value, and CHAR(4) is the character
representation of the requested value. The order that the variables are put
into storage is binary first and then character.</p>
<p><strong>Card position.</strong> The physical location where the device or
feature is plugged into the bus.</p>
<p><strong>Color flag.</strong> Whether the resource supports a color
attribute. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Console usage.</strong> A value that indicates whether this resource
is the primary console, the secondary console, or not used as a console of the
system.</p>
<table border width="80%">
<tr>
<th align="left" valign="top">Resource</th>
<th align="left" valign="top">Returned value</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Not used as console</td>
<td align="left" valign="top" width="50%">X'4000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Used as primary console</td>
<td align="left" valign="top">X'4FFFFFFFFFFFFFFF'</td>
</tr>
<tr>
<td align="left" valign="top">Used as secondary console</td>
<td align="left" valign="top">X'0000000000000001'</td>
</tr>
</table>
<p><strong>Contact data.</strong> The data that is received by the resource
when it is contacted.</p>
<p><strong>Controller description needed flag.</strong> Whether the controller
description is needed with this resource. Valid values for this field are 0
(No) and 1 (Yes).</p>
<p><strong>DASD candidate flag.</strong> Whether a storage device is a direct
access storage device (DASD). Valid values for this field are 0 (No) and 1
(Yes).</p>
<p><strong>DCE adapter card flag.</strong> Whether the resource is a data
circuit-terminating equipment (DCE) card adapter. Valid values for this field
are 0 (No) and 1 (Yes).</p>
<p><strong>Device address.</strong> A unique identifier for each device, so
that the device is recognized by the system. The value for this field is
returned as BINARY(2) and CHAR(4). Both variables, BINARY(2) and CHAR(4), are
the same. BINARY(2) is the binary representation of the requested value, and
CHAR(4) is the character representation of the requested value. The order that
the variables are put into storage is binary first and then character.</p>
<p><strong>Device position.</strong> A unique identifier for each device within
its containing frame.</p>
<p><strong>EIA.</strong> A value that represents the physical position of the
resource in its containing frame.</p>
<p><strong>Emulating model.</strong> A model number for which this resource is
emulating.</p>
<p><strong>Emulating type.</strong> The object type number that this resource
is emulating.</p>
<p><strong>FAX communications flag.</strong> Whether this communications
resource is a FAX-type communication. Valid values for this field are 0 (No)
and 1 (Yes).</p>
<p><strong>Frame ID.</strong> The identifier of a supplied frame resource.</p>
<p><strong>Frame resource name.</strong> The resource name of the frame that a
known resource resides in.</p>
<p><strong>File server I/O processor flag.</strong> Whether the resource is an
Integrated PC Server (also known as file server I/O processor and FSIOP). Valid
values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>High-speed digital flag.</strong> Whether the resource is a
high-speed digital communications line. Valid values for this field are 0 (No)
and 1 (Yes).</p>
<p><strong>Host model.</strong> The model of the host resource.</p>
<p><strong>Host name.</strong> The name of the host resource.</p>
<p><strong>Host serial.</strong> The serial number of the host resource.</p>
<p><strong>Host this system.</strong> Whether the resource is the host of this
system. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Host type.</strong> The type of the host resource.</p>
<p><strong>In library.</strong> Whether the resource is in a library. Valid
values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Installed memory.</strong> The amount of memory, in megabytes,
installed in the resource.</p>
<p><strong>Interactive feature.</strong> The interactive feature of the system.
This feature defines the portion of the processor that can be used to perform
interactive work.</p>
<p><strong>Interface adapter card flag.</strong> Whether the resource is an
interface adapter card. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>I/O adapter
address.</strong> The address of the I/O adapter where the resource is plugged
into. The value for this field is returned as BINARY(2) and CHAR(4). Both
variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary
representation of the requested value, and CHAR(4) is the character
representation of the requested value. The order that the variables are put
into storage is binary first and then character.</p>
<p><strong>IOP has DASD flag.</strong> Whether the resource (IOP) has a direct
access storage device (DASD) attached. Valid values for this field are 0 (No)
and 1 (Yes).</p>
<p><strong>Is an OEM.</strong> Whether the resource is an original equipment
manufacturer (OEM) resource. Valid values for this field are 0 (No) and 1
(Yes).</p>
<p><strong>Is daughter card flag.</strong> Whether the resource is a daughter
card. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Is shared.</strong> Whether the resource is shared. Valid values for
this field are 0 (No) and 1 (Yes).</p>
<p><strong>Keyboard type.</strong> The physical key arrangement and assignments
for the keyboard shipped from the factory.</p>
<p><strong>Keyboard type extended.</strong> Additional information about the
keyboard type.</p>
<p><strong>LAN flag.</strong> Whether the resource is a local area network
(LAN). Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>LAN speed.</strong> A value that returns the line speed of a
LAN.</p>
<p><strong>Library
address.</strong> The address of the library where the resource is plugged
into. The value for this field is returned as BINARY(2) and CHAR(2). Both
variables, BINARY(2) and CHAR(2), are the same. BINARY(2) is the binary
representation of the requested value, and CHAR(2) is the character
representation of the requested value. The order that the variables are put
into storage is binary first and then character.</p>
<p><strong>Location Code Format.</strong>
Whether the location code is supported on the system. Valid values for this field are 0
(No) and 1 (Yes).</p>
<p><strong>Location Code.</strong> The physical location of the hardware
resource in the system. This field is be available only if the system
supports the location code format. The location code field is a sequence of
0 or more location labels that when followed in order, lead to the resource
location. This is the place someone could go to view, remove, or replace
the piece of hardware. Location labels are etched, silk screened, or marked
in other ways on hardware. The following location labels might be shown in
the location code field (n represents a numerical or alphabetical identifier):
</p>
<dl>
<dt>Utttt.mmm.sssssss</dt>
<dd>Unit location</dd>
<dt>Pnn</dt>
<dd>Planar location</dd>
<dt>Cnn</dt>
<dd>Card location</dd>
<dt>Tnn</dt>
<dd>Port location</dd>
<dt>Dnn</dt>
<dd>Device location</dd>
<dt>Vnnn</dt>
<dd>Virtual planar</dd>
<dt>Wnnnnnnnnnnnnnnnn</dt>
<dd>Worldwide port name</dd>
<dt>Lnn</dt>
<dd>Logical path location</dd>
</dl>
<p>Following are the descriptions of the location labels:</p>
<p>
Unit location. Value of the unit enclosure identifier composed of uppercase
alphabetic characters and digits. Commonly this value will be composed of the
machine type (tttt), model (mmm) and serial number (sssssss).
<br>Planar location. Decimal value of the planar identfier within the unit.
<br>Card location. The decimal value of the position of the card within the
hardware package. This can be followed by additional card location labels that
would identify the decimal value of additional card positions of the resource
on the card.
<br>Port location. The decimal value of the port location within the resource.
<br>Device location. The decimal value of the position of the device within the
hardware package.
<br>Virtual planar. The decimal value of the position of the virtual planar
resource within the hardware package.
<br>Worldwide port name. The hexadecimal value of the worldwide port name of
the resource within the hardware
package.
<br>Logical path location. The decimal value of the logical path of the
resource within the hardware package. This can be followed by additional logical
path location labels that would identify the decimal value of additional logical
path data of the resource on the hardware package.</p>
<p><strong>Maximum frame size.</strong> The maximum path information unit (PIU)
size that the controller can send or receive.</p>
<p><strong>Maximum lines attached.</strong> A value that indicates the maximum
number of lines that can be attached to a resource.</p>
<p><strong>Maximum ports attached.</strong> A value that indicates the maximum
number of ports associated with a resource.</p>
<p><strong>Media type.</strong> The media type identifier of the resource.</p>
<p><strong>Memory size.</strong> The amount of memory associated with this
resource.</p>
<p><strong>Model number.</strong> The model number of the resource.</p>
<p><strong>Normal mode flag.</strong> Whether the resource is in normal mode.
Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Number of resources.</strong> The number of resources connected to a
known resource.</p>
<p><strong>Operational flag.</strong> Whether the resource is designated as
operational. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Part number.</strong> A manufacturing identifier that represents
similar types of hardware.</p>
<p><strong>Plant of manufacture number.</strong> An identifier that represents
the manufacturing plant of this resource.</p>
<p><strong>Powered-on flag.</strong> Whether the resource is powered on. Valid
values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Processor feature.</strong> The processor feature, corresponding to
the processor capacity of the system.</p>
<p><strong>Programmable flag.</strong> Whether the resource supports the
programmable attribute. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>RCTT level.</strong> The Reference Code Translation Table (RCTT)
identifier.</p>
<p><strong>Read format.</strong> The type of read format used by the
resource.</p>
<p><strong>Remote model.</strong> The model of the remote resource.</p>
<p><strong>Remote name.</strong> The name of the remote resource.</p>
<p><strong>Remote serial.</strong> The serial number of the remote
resource.</p>
<p><strong>Remote type.</strong> The type of the remote resource.</p>
<p><strong>Reported this IPL flag.</strong> Whether the resource reported this
initial program load (IPL). Valid values for this field are 0 (No) and 1
(Yes).</p>
<p><strong>Resource classification 1.</strong> The type of hardware that the
resource is.</p>
<table border width="80%">
<tr>
<th align="left" valign="top">Hardware type</th>
<th align="left" valign="top">Returned value</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Not available</td>
<td align="left" valign="top" width="50%">X'4000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Any classification 1</td>
<td align="left" valign="top">X'4FFFFFFFFFFFFFFF'</td>
</tr>
<tr>
<td align="left" valign="top">IOP</td>
<td align="left" valign="top">X'0000000000000001'</td>
</tr>
<tr>
<td align="left" valign="top">Controller</td>
<td align="left" valign="top">X'0000000000000002'</td>
</tr>
<tr>
<td align="left" valign="top">Device</td>
<td align="left" valign="top">X'0000000000000004'</td>
</tr>
<tr>
<td align="left" valign="top">Port</td>
<td align="left" valign="top">X'0000000000000008'</td>
</tr>
<tr>
<td align="left" valign="top">Channel</td>
<td align="left" valign="top">X'0000000000000010'</td>
</tr>
<tr>
<td align="left" valign="top">Library</td>
<td align="left" valign="top">X'0000000000000020'</td>
</tr>
<tr>
<td align="left" valign="top">Bus controller</td>
<td align="left" valign="top">X'0000000000000040'</td>
</tr>
<tr>
<td align="left" valign="top">IO node</td>
<td align="left" valign="top">X'0000000000000080'</td>
</tr>
<tr>
<td align="left" valign="top">Bus</td>
<td align="left" valign="top">X'0000000000000100'</td>
</tr>
<tr>
<td align="left" valign="top">Bus extension</td>
<td align="left" valign="top">X'0000000000000200'</td>
</tr>
<tr>
<td align="left" valign="top">PIU</td>
<td align="left" valign="top">X'0000000000000400'</td>
</tr>
<tr>
<td align="left" valign="top">PCK</td>
<td align="left" valign="top">X'0000000000000800'</td>
</tr>
<tr>
<td align="left" valign="top">PCI node</td>
<td align="left" valign="top">X'0000000000001000'</td>
</tr>
</table>
<p><strong>Resource classification 2.</strong> The type of controller that the
resource is.</p>
<table border width="80%">
<tr>
<th align="left" valign="top">Controller type</th>
<th align="left" valign="top">Returned value</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Not available</td>
<td align="left" valign="top" width="50%">X'4000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Any classification 2</td>
<td align="left" valign="top">X'4FFFFFFFFFFFFFFF'</td>
</tr>
<tr>
<td align="left" valign="top">Workstation</td>
<td align="left" valign="top">X'0000000000000001'</td>
</tr>
<tr>
<td align="left" valign="top">Storage</td>
<td align="left" valign="top">X'0000000000000002'</td>
</tr>
<tr>
<td align="left" valign="top">Workstation storage</td>
<td align="left" valign="top">X'0000000000000003'</td>
</tr>
<tr>
<td align="left" valign="top">Communications</td>
<td align="left" valign="top">X'0000000000000004'</td>
</tr>
<tr>
<td align="left" valign="top">Workstation communications</td>
<td align="left" valign="top">X'0000000000000005'</td>
</tr>
<tr>
<td align="left" valign="top">Storage communications</td>
<td align="left" valign="top">X'0000000000000006'</td>
</tr>
<tr>
<td align="left" valign="top">Storage communications workstation</td>
<td align="left" valign="top">X'0000000000000007'</td>
</tr>
<tr>
<td align="left" valign="top">Shared object clustering (SOC)</td>
<td align="left" valign="top">X'0000000000000008'</td>
</tr>
<tr>
<td align="left" valign="top">Cryptographic</td>
<td align="left" valign="top">X'0000000000000010'</td>
</tr>
<tr>
<td align="left" valign="top">
Workstation cryptography</td>
<td align="left" valign="top">X'0000000000000011'</td>
</tr>
<tr>
<td align="left" valign="top">Storage cryptography</td>
<td align="left" valign="top">X'0000000000000012'</td>
</tr>
<tr>
<td align="left" valign="top">Storage workstation cryptography</td>
<td align="left" valign="top">X'0000000000000013'</td>
</tr>
<tr>
<td align="left" valign="top">Communication cryptography</td>
<td align="left" valign="top">X'0000000000000014'</td>
</tr>
<tr>
<td align="left" valign="top">Communication workstation cryptography</td>
<td align="left" valign="top">X'0000000000000015'</td>
</tr>
<tr>
<td align="left" valign="top">Storage communications cryptography</td>
<td align="left" valign="top">X'0000000000000016'</td>
</tr>
<tr>
<td align="left" valign="top">Storage communications workstation
cryptography</td>
<td align="left" valign="top">X'0000000000000017'</td>
</tr>
</table>
<p><strong>Resource classification 3.</strong> The type of device that the
resource is.</p>
<table border width="80%">
<tr>
<th align="left" valign="top">Device type</th>
<th align="left" valign="top">Returned value</th>
</tr>
<tr>
<td align="left" valign="top" width="50%">Not available</td>
<td align="left" valign="top" width="50%">X'4000000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Any classification 3</td>
<td align="left" valign="top">X'4FFFFFFFFFFFFFFF'</td>
</tr>
<tr>
<td align="left" valign="top">Display</td>
<td align="left" valign="top">X'0000000000000001'</td>
</tr>
<tr>
<td align="left" valign="top">Printer</td>
<td align="left" valign="top">X'0000000000000002'</td>
</tr>
<tr>
<td align="left" valign="top">DASD</td>
<td align="left" valign="top">X'0000000000000004'</td>
</tr>
<tr>
<td align="left" valign="top">Diskette</td>
<td align="left" valign="top">X'0000000000000008'</td>
</tr>
<tr>
<td align="left" valign="top">
Dasd Diskette</td>
<td align="left" valign="top">X'000000000000000C'</td>
</tr>
<tr>
<td align="left" valign="top">Optical</td>
<td align="left" valign="top">X'0000000000000010'</td>
</tr>
<tr>
<td align="left" valign="top">Tape</td>
<td align="left" valign="top">X'0000000000000020'</td>
</tr>
<tr>
<td align="left" valign="top">
Dasd Tape</td>
<td align="left" valign="top">X'0000000000000024'</td>
</tr>
<tr>
<td align="left" valign="top">Dasd Tape Diskette</td>
<td align="left" valign="top">X'000000000000002C'</td>
</tr>
<tr>
<td align="left" valign="top">Tape Optical</td>
<td align="left" valign="top">X'0000000000000030'</td>
</tr>
<tr>
<td align="left" valign="top">Removable media</td>
<td align="left" valign="top">X'0000000000000038'</td>
</tr>
<tr>
<td align="left" valign="top">
Dasd Tape Diskette Optical</td>
<td align="left" valign="top">X'000000000000003C'</td>
</tr>
<tr>
<td align="left" valign="top">ISDN</td>
<td align="left" valign="top">X'0000000000000040'</td>
</tr>
<tr>
<td align="left" valign="top">X.25</td>
<td align="left" valign="top">X'0000000000000080'</td>
</tr>
<tr>
<td align="left" valign="top">Token ring</td>
<td align="left" valign="top">X'0000000000000100'</td>
</tr>
<tr>
<td align="left" valign="top">SDLC</td>
<td align="left" valign="top">X'0000000000000200'</td>
</tr>
<tr>
<td align="left" valign="top">Ethernet</td>
<td align="left" valign="top">X'0000000000000400'</td>
</tr>
<tr>
<td align="left" valign="top">
Token ring/Ethernet</td>
<td align="left" valign="top">X'0000000000000500'</td>
</tr>
<tr>
<td align="left" valign="top">FDDI</td>
<td align="left" valign="top">X'0000000000000800'</td>
</tr>
<tr>
<td align="left" valign="top">Token ring FDDI</td>
<td align="left" valign="top">X'0000000000000900'</td>
</tr>
<tr>
<td align="left" valign="top">Frame relay</td>
<td align="left" valign="top">X'0000000000001000'</td>
</tr>
<tr>
<td align="left" valign="top">Frame relay SDLC</td>
<td align="left" valign="top">X'0000000000001200'</td>
</tr>
<tr>
<td align="left" valign="top">Cryptographic</td>
<td align="left" valign="top">X'0000000000002000'</td>
</tr>
<tr>
<td align="left" valign="top">Fax</td>
<td align="left" valign="top">X'0000000000004000'</td>
</tr>
<tr>
<td align="left" valign="top">Memory</td>
<td align="left" valign="top">X'0000000000008000'</td>
</tr>
<tr>
<td align="left" valign="top">Service processor</td>
<td align="left" valign="top">X'0000000000010000'</td>
</tr>
<tr>
<td align="left" valign="top">Main processor</td>
<td align="left" valign="top">X'0000000000020000'</td>
</tr>
<tr>
<td align="left" valign="top">Bus controller</td>
<td align="left" valign="top">X'0000000000040000'</td>
</tr>
<tr>
<td align="left" valign="top">System information</td>
<td align="left" valign="top">X'0000000000080000'</td>
</tr>
<tr>
<td align="left" valign="top">Control panel</td>
<td align="left" valign="top">X'0000000000100000'</td>
</tr>
<tr>
<td align="left" valign="top">Bus adapter</td>
<td align="left" valign="top">X'0000000000200000'</td>
</tr>
<tr>
<td align="left" valign="top">SPD bus</td>
<td align="left" valign="top">X'0000000000400000'</td>
</tr>
<tr>
<td align="left" valign="top">Bus extension</td>
<td align="left" valign="top">X'0000000000800000'</td>
</tr>
<tr>
<td align="left" valign="top">Sba PIU</td>
<td align="left" valign="top">X'0000000001000000'</td>
</tr>
<tr>
<td align="left" valign="top">Twin optical bus controller</td>
<td align="left" valign="top">X'0000000002000000'</td>
</tr>
<tr>
<td align="left" valign="top">ASCII</td>
<td align="left" valign="top">X'0000000004000000'</td>
</tr>
<tr>
<td align="left" valign="top">ASCII display</td>
<td align="left" valign="top">X'0000000004000001'</td>
</tr>
<tr>
<td align="left" valign="top">ASCII printer</td>
<td align="left" valign="top">X'0000000004000002'</td>
</tr>
<tr>
<td align="left" valign="top">Twinaxial</td>
<td align="left" valign="top">X'0000000008000000'</td>
</tr>
<tr>
<td align="left" valign="top">Twinaxial display</td>
<td align="left" valign="top">X'0000000008000001'</td>
</tr>
<tr>
<td align="left" valign="top">Twinaxial printer</td>
<td align="left" valign="top">X'0000000008000002'</td>
</tr>
<tr>
<td align="left" valign="top">Apple</td>
<td align="left" valign="top">X'0000000010000000'</td>
</tr>
<tr>
<td align="left" valign="top">Apple token ring LAN</td>
<td align="left" valign="top">X'0000000010000100'</td>
</tr>
<tr>
<td align="left" valign="top">Apple Ethernet</td>
<td align="left" valign="top">X'0000000010000400'</td>
</tr>
<tr>
<td align="left" valign="top">Wireless</td>
<td align="left" valign="top">X'0000000020000000'</td>
</tr>
<tr>
<td align="left" valign="top">SOC host</td>
<td align="left" valign="top">X'0000000040000000'</td>
</tr>
<tr>
<td align="left" valign="top">SOC nonhost</td>
<td align="left" valign="top">X'0000000080000000'</td>
</tr>
<tr>
<td align="left" valign="top">Internetwork Packet Exchange (IPX)</td>
<td align="left" valign="top">X'0000000100000000'</td>
</tr>
<tr>
<td align="left" valign="top">File server</td>
<td align="left" valign="top">X'0000000200000000'</td>
</tr>
<tr>
<td align="left" valign="top">ATM</td>
<td align="left" valign="top">X'0000000400000000'</td>
</tr>
<tr>
<td align="left" valign="top">ATM Ethernet</td>
<td align="left" valign="top">X'0000000400000400'</td>
</tr>
<tr>
<td align="left" valign="top">Backplane</td>
<td align="left" valign="top">X'0000000800000000'</td>
</tr>
<tr>
<td align="left" valign="top">System clock</td>
<td align="left" valign="top">X'0000001000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Optical library</td>
<td align="left" valign="top">X'0000002000000000'</td>
</tr>
<tr>
<td align="left" valign="top">PCI Bus</td>
<td align="left" valign="top">X'0000004000000000'</td>
</tr>
<tr>
<td align="left" valign="top">PHB Bus controller</td>
<td align="left" valign="top">X'0000008000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO Bus adapter</td>
<td align="left" valign="top">X'0000010000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Cache</td>
<td align="left" valign="top">X'0000020000000000'</td>
</tr>
<tr>
<td align="left" valign="top">
Virtual SOC IOP</td>
<td align="left" valign="top">X'0000040000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Virtual resource</td>
<td align="left" valign="top">X'0000080000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Virtual Optical</td>
<td align="left" valign="top">X'0000080000000010'</td>
</tr>
<tr>
<td align="left" valign="top">Virtual Twin Optical Bus controller</td>
<td align="left" valign="top">X'0000080002000000'</td>
</tr>
<tr>
<td align="left" valign="top">Processor capacity card</td>
<td align="left" valign="top">X'0000100000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Interactive card</td>
<td align="left" valign="top">X'0000200000000000'</td>
</tr>
<tr>
<td align="left" valign="top">
Storage Enclosure Services (SES) device</td>
<td align="left" valign="top">X'0000400000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO controller Bus Control Chip (BuCC)</td>
<td align="left" valign="top">X'0000800000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO bus</td>
<td align="left" valign="top">X'0001000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO SAN bus adapter</td>
<td align="left" valign="top">X'0002000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO SAN bus</td>
<td align="left" valign="top">X'0004000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO SAN BuCC</td>
<td align="left" valign="top">X'0008000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">RIO SAN SOC IOP</td>
<td align="left" valign="top">X'0010000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Riser</td>
<td align="left" valign="top">X'0020000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">L3 Cache</td>
<td align="left" valign="top">X'0040000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Backplane extender</td>
<td align="left" valign="top">X'0080000000000000'</td>
</tr>
<tr>
<td align="left" valign="top">Capacitor card</td>
<td align="left" valign="top">X'0100000000000000'</td>
</tr>
</table>
<p><strong>Resource ID.</strong> The identification (ID) of the resource.</p>
<p><strong>rvxCommunication.</strong> Whether the resource is an RS232
connecting device. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Serial number.</strong> The manufacturing sequence number of
designation of the resource.</p>
<p><strong>Supplied data at IPL flag.</strong> Whether the resource supplied
data at IPL. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Supported on system flag.</strong> Whether the resource is supported
on the system. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Supports assign command flag.</strong> Whether the resource supports
the assign command. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Supports TWERP flag.</strong> Whether the resource supports TWERP.
Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Transport type.</strong> The transport type identification that is
returned. The value for this field is returned as BINARY(2) and CHAR(4). Both
variables, BINARY(2) and CHAR(4), are the same. BINARY(2) is the binary
representation of the requested value, and CHAR(4) is the character
representation of the requested value. The order that the variables are put
into storage is binary first and then character. Valid values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">SPD bus</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">PCI bus</td>
</tr>
</table>
<p><strong>Type number.</strong> An identifier that represents the object type
of this resource.</p>
<p><strong>UA type.</strong> The type of unit address that is returned. The
value for this field is returned as BINARY(2) and CHAR(2). Both variables,
BINARY(2) and CHAR(2), are the same. BINARY(2) is the binary representation of
the requested value, and CHAR(2) is the character representation of the
requested value. The order that the variables are put into storage is binary
first and then character.</p>
<p><strong>Usable memory.</strong> The amount of memory, in megabytes, that is
available for the resource to use.</p>
<p><strong>User configurable flag.</strong> Whether the resource can be
configured by the user. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>User location text.</strong> A text string that identifies where
this resource is physically located.</p>
<p><strong>Wide screen flag.</strong> Whether the resource supports the
wide-screen attribute. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Write format.</strong> The type of write format used by the
resource.</p>
<p><strong>X.21 interface.</strong> Whether the communications resource is of
type X.21. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>Vary-on wait time.</strong> The number of seconds needed for this
resource to typically vary on.</p>
<p><strong>V.24 interface.</strong> Whether the communications resource is of
type V.24. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>V.35 interface.</strong> Whether the communications resource is of
type V.35. Valid values for this field are 0 (No) and 1 (Yes).</p>
<p><strong>V.36 interface.</strong> Whether the communications resource is of
type V.36. Valid values for this field are 0 (No) and 1 (Yes).</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top" nowrap>Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF0B3B E</td>
<td align="left" valign="top">Resource name not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B3F E</td>
<td align="left" valign="top">The reserved area is not set to binary
zeros.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B33 E</td>
<td align="left" valign="top">The handle is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B34 E</td>
<td align="left" valign="top">The handle is in wrong state for operation.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B38 E</td>
<td align="left" valign="top">Resource information not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B39 E</td>
<td align="left" valign="top">Data requested by key &amp;1 is not
applicable.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B46 E</td>
<td align="left" valign="top">Materialize failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B48 E</td>
<td align="left" valign="top">Number of keys &amp;1 is more than number of keys
allowed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF0B3A E</td>
<td align="left" valign="top">Resource name &amp; is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td align="left" valign="top">Severe error while addressing parameter
list.</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 &amp;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">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: V3R6
<hr>
<table align="center" 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">API by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue Copy Permalink