ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/qgyrhri.htm

1212 lines
33 KiB
HTML
Raw Permalink Normal View History

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 Hardware Resource Information (QGYRHRI, QgyRtvHdwRscInfo)
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. -->
<!-- This file has undergone html cleanup on 1/14/02 by JET -->
<!-- Change history: -->
<!-- 030509 caton : Added new location code field for DCR XPF -->
<!-- 99135, changed under defect 3255.1 -->
<!-- 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 Hardware Resource Information (QGYRHRI, QgyRtvHdwRscInfo) 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">Resource name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Error code</td>
<td align="left" valign="top">I/O</td>
<td align="left" valign="top">Char(*)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Service Program Name: QGYRHR<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve Hardware Resource Information (OPM, QGYRHRI; ILE,
QgyRtvHdwRscInfo) API retrieves hardware resource information fields that,
together with the output from the Retrieve Hardware Resource List (OPM,
QGYRHRL; ILE, QgyRtvHdwRscList) API, provide a detailed description of the
resource identified by the resource name parameter. This API is meant to be
used after obtaining a list of resource names with the Retrieve Hardware
Resource List API.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>API Public Authority</em></dt>
<dd>*USE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p> The 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 that is returned. The possible
format names are as follows:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>RHRI0100</em></td>
<td align="left" valign="top">Detailed information for communication hardware
resources. For more information, see <a href="#HDRHRI0100">RHRI0100
Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RHRI0200</em></td>
<td align="left" valign="top">Detailed information for coupled system adapter
resources. For more information, see <a href="#HDRHRI0200">RHRI0200
Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RHRI0300</em></td>
<td align="left" valign="top">Detailed information for local workstation
resources. For more information, see <a href="#HDRHRI0300">RHRI0300
Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RHRI0400</em></td>
<td align="left" valign="top">Detailed information for processor resources. For
more information, see <a href="#HDRHRI0400">RHRI0400 Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RHRI0410</em></td>
<td align="left" valign="top">Detailed information for processor resources.
Using this format allows information for the Processor Capacity Card and
Interactive Card to be returned. For more information, see <a href=
"#HDRHRI0410">RHRI0410 Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RHRI0500</em></td>
<td align="left" valign="top">Detailed information for storage device
resources, including tape and optical resources. For more information, see <a
href="#HDRHRI0500">RHRI0500 Format</a>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>RHRI0600</em></td>
<td align="left" valign="top">Detailed information for cryptographic resources.
For more information, see <a href="#HDRHRI0600">RHRI0600 Format</a>.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Resource name</strong></dt>
<dd>INPUT; CHAR(10)
<p> The name of the hardware resource for which information is to be
returned.</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="HDRHRI0100">RHRI0100 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">System bus number</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">System board number</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">System card number</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">I/O bus address</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Adapter address</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Port number</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Serial number</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Part number</td>
</tr>
<tr>
<td align="center" valign="top">54</td>
<td align="center" valign="top">36</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Frame ID</td>
</tr>
<tr>
<td align="center" valign="top">58</td>
<td align="center" valign="top">3A</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Card position</td>
</tr>
<tr>
<td align="center" valign="top">63</td>
<td align="center" valign="top">3F</td>
<td align="left" valign="top">CHAR(79)</td>
<td align="left" valign="top">Location code</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRHRI0200">RHRI0200 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">System bus number</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">System board number</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">System card number</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Serial number</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Part number</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Frame ID</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="center" valign="top">2E</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Card position</td>
</tr>
<tr>
<td align="center" valign="top">51</td>
<td align="center" valign="top">33</td>
<td align="left" valign="top">CHAR(79)</td>
<td align="left" valign="top">Location code</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRHRI0300">RHRI0300 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">System bus number</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">System board number</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">System card number</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">I/O bus address</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Adapter address</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Port number</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Device address</td>
</tr>
<tr>
<td align="center" valign="top">36</td>
<td align="center" valign="top">24</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Shared session number</td>
</tr>
<tr>
<td align="center" valign="top">40</td>
<td align="center" valign="top">28</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Serial number</td>
</tr>
<tr>
<td align="center" valign="top">50</td>
<td align="center" valign="top">32</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Part number</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Frame ID</td>
</tr>
<tr>
<td align="center" valign="top">66</td>
<td align="center" valign="top">42</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Card position</td>
</tr>
<tr>
<td align="center" valign="top">71</td>
<td align="center" valign="top">47</td>
<td align="left" valign="top">CHAR(79)</td>
<td align="left" valign="top">Location code</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRHRI0400">RHRI0400 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">System bus number</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">System board number</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">System card number</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Serial number</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Part number</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Frame ID</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="center" valign="top">2E</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Card position</td>
</tr>
<tr>
<td align="center" valign="top">51</td>
<td align="center" valign="top">33</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">System processor feature code</td>
</tr>
<tr>
<td align="center" valign="top">55</td>
<td align="center" valign="top">37</td>
<td align="left" valign="top">CHAR(79)</td>
<td align="left" valign="top">Location code</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRHRI0410">RHRI0410 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">System bus number</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">System board number</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">System card number</td>
</tr>
<tr>
<td align="center" valign="top">20</td>
<td align="center" valign="top">14</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Serial number</td>
</tr>
<tr>
<td align="center" valign="top">30</td>
<td align="center" valign="top">1E</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Part number</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Frame ID</td>
</tr>
<tr>
<td align="center" valign="top">46</td>
<td align="center" valign="top">2E</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Card position</td>
</tr>
<tr>
<td align="center" valign="top">51</td>
<td align="center" valign="top">33</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">System processor feature code</td>
</tr>
<tr>
<td align="center" valign="top">55</td>
<td align="center" valign="top">37</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Processor feature code</td>
</tr>
<tr>
<td align="center" valign="top">59</td>
<td align="center" valign="top">3B</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Interactive feature code</td>
</tr>
<tr>
<td align="center" valign="top">63</td>
<td align="center" valign="top">3F</td>
<td align="left" valign="top">CHAR(79)</td>
<td align="left" valign="top">Location code</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRHRI0500">RHRI0500 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">System bus number</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">System board number</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">System card number</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">I/O bus address</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Controller address</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Device address</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Device position</td>
</tr>
<tr>
<td align="center" valign="top">37</td>
<td align="center" valign="top">25</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Serial number</td>
</tr>
<tr>
<td align="center" valign="top">47</td>
<td align="center" valign="top">2F</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Part number</td>
</tr>
<tr>
<td align="center" valign="top">59</td>
<td align="center" valign="top">3B</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Frame ID</td>
</tr>
<tr>
<td align="center" valign="top">63</td>
<td align="center" valign="top">3F</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Card position</td>
</tr>
<tr>
<td align="center" valign="top">68</td>
<td align="center" valign="top">44</td>
<td align="left" valign="top">CHAR(79)</td>
<td align="left" valign="top">Location code</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRHRI0600">RHRI0600 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">System bus number</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">System board number</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">System card number</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">I/O bus address</td>
</tr>
<tr>
<td align="center" valign="top">24</td>
<td align="center" valign="top">18</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Adapter address</td>
</tr>
<tr>
<td align="center" valign="top">28</td>
<td align="center" valign="top">1C</td>
<td align="left" valign="top">BINARY(4)</td>
<td align="left" valign="top">Device address</td>
</tr>
<tr>
<td align="center" valign="top">32</td>
<td align="center" valign="top">20</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Serial number</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(12)</td>
<td align="left" valign="top">Part number</td>
</tr>
<tr>
<td align="center" valign="top">54</td>
<td align="center" valign="top">36</td>
<td align="left" valign="top">CHAR(4)</td>
<td align="left" valign="top">Frame ID</td>
</tr>
<tr>
<td align="center" valign="top">58</td>
<td align="center" valign="top">3A</td>
<td align="left" valign="top">CHAR(5)</td>
<td align="left" valign="top">Card position</td>
</tr>
<tr>
<td align="center" valign="top">63</td>
<td align="center" valign="top">3F</td>
<td align="left" valign="top">CHAR(79)</td>
<td align="left" valign="top">Location code</td>
</tr>
</table>
<br>
<br>
<h3><a name="HDRRHRIFD">Field Descriptions</a></h3>
<p><strong>Adapter address.</strong> The adapter address of the resource. A
value of -1 means that this field does not apply to the resource.</p>
<p><strong>Bytes available.</strong> The number of bytes of data available to
be returned. All available data is returned if enough space is provided.</p>
<p><strong>Bytes returned.</strong> The number of bytes of data returned.</p>
<p><strong>Card position.</strong> The physical location where the device or
feature is plugged into the bus.</p>
<p><strong>Controller address.</strong> The controller address of the resource.
A value of -1 means that this field does not apply to the resource.</p>
<p><strong>Device address.</strong> The device address of the resource. A value
of -1 means that this field does not apply to the resource.</p>
<p><strong>Device position.</strong> The relative device position of the
resource.</p>
<p><strong>Frame ID.</strong> The identifier of a frame resource.</p>
<p><strong>Interactive feature code.</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>I/O bus address.</strong> The I/O bus address of the resource. A
value of -1 means that this field does not apply to the resource.</p>
<p><strong>Location code.</strong> The
physical location of the hardware resource in the system. This field is available
only if the system supports the location code format, otherwise will be set to
blanks. 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>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>Utttt.mmm.sssssss</em></td>
<td align="left" valign="top">Unit location</td>
</tr>
<tr>
<td align="left" valign="top"><em>Pnn</em></td>
<td align="left" valign="top">Planar location</td>
</tr>
<tr>
<td align="left" valign="top"><em>Cnn</em></td>
<td align="left" valign="top">Card location</td>
</tr>
<tr>
<td align="left" valign="top"><em>Tnn</em></td>
<td align="left" valign="top">Port location</td>
</tr>
<tr>
<td align="left" valign="top"><em>Dnn</em></td>
<td align="left" valign="top">Device location</td>
</tr>
<tr>
<td align="left" valign="top"><em>Vnnn</em></td>
<td align="left" valign="top">Virtual planar</td>
</tr>
<tr>
<td align="left" valign="top"><em>Wnnnnnnnnnnnnnnnn</em></td>
<td align="left" valign="top">Worldwide port name</td>
</tr>
<tr>
<td align="left" valign="top"><em>Lnn</em></td>
<td align="left" valign="top">Logical path location</td>
</tr>
</table>
<p>Following are the descriptions of the location labels:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top">Unit location</td>
<td align="left" valign="top">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).</td>
</tr>
<tr>
<td align="left" valign="top">Planar location</td>
<td align="left" valign="top">Decimal value of the planar identifier within
the unit.</td>
</tr>
<tr>
<td align="left" valign="top">Card location</td>
<td align="left" valign="top">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.</td>
</tr>
<tr>
<td align="left" valign="top">Port location</td>
<td align="left" valign="top">The decimal value of the port location within
the resource.</td>
</tr>
<tr>
<td align="left" valign="top">Device location</td>
<td align="left" valign="top">The decimal value of the position of the
device within the hardware package.</td>
</tr>
<tr>
<td align="left" valign="top">Virtual planar</td>
<td align="left" valign="top">The decimal value of the position of the
virtual planar resource within the hardware package.</td>
</tr>
<tr>
<td align="left" valign="top">Worldwide port name</td>
<td align="left" valign="top">The hexadecimal value of the worldwide port
name of the resource within the hardware package.</td>
</tr>
<tr>
<td align="left" valign="top">Logical path location</td>
<td align="left" valign="top">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.</td>
</tr>
</table>
<p><strong>Part number.</strong> A manufacturing identifier that represents
similar types of hardware.</p>
<p><strong>Port number.</strong> The port number of the resource. A value of -1
means that this field does not apply to the resource.</p>
<p><strong>Processor feature code.</strong> The processor feature, which
corresponds to the processor capacity of the system.</p>
<p><strong>Serial number.</strong> The manufacturing sequence number of
designation for the resource.</p>
<p><strong>Shared session number.</strong> The shared session number of the
resource. A value of -1 means that this field does not apply to the
resource.</p>
<p><strong>System board number.</strong> A numerical representation of a
section of the bus into which the card is plugged. A value of -1 means that
this field does not apply to the resource.</p>
<p><strong>System bus number.</strong> A numerical representation of the path
connection of the system processor to the card. A value of -1 means that this
field does not apply to the resource.</p>
<p><strong>System card number.</strong> A numerical representation of the
location of the card on the bus. A value of -1 means that this field does not
apply to the resource.</p>
<p><strong>System processor feature code.</strong> The processor feature code
level of the system. A value is returned for this field only if the Kind 3
value of the hardware resource indicates that the resource provides system
information (X'0000000000080000'). The Kind 3 value is returned in the
&quot;Resource kind&quot; field by the Retrieve Hardware Resource List API.</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">CPFA290 E</td>
<td align="left" valign="top">Resource name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C1E E</td>
<td align="left" valign="top">Required parameter &amp;1 omitted.</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: V3R7
<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>