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/quhrhlpt.htm

731 lines
20 KiB
HTML
Raw Blame History

<!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 Help Text (QUHRHLPT) 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. -->
<!-- Created for V5R1-->
<!--Edited by Kersten Nov 2001 -->
<!-- Updates from System API Programming book phase-out, February 2003 by JET -->
<!-- Change history: -->
<!-- 030718 KYLEG :Add CPF6E3B for XPF D99286.10 -->
<!-- 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 Help Text (QUHRHLPT) 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">Help identifiers to be retrieved</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Array(*) of (*)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Number of help identifiers</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">6</td>
<td align="left" valign="top">Help identifier text</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">7</td>
<td align="left" valign="top">Length of help identifier text</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">8</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 Retrieve Help Text (QUHRHLPT) API lets you generate an Extensible Markup
Language (XML) source listing of the help identifiers in a panel group or menu
object. The QUHRHLPT API returns the XML source in UTF-8 (CCSID 1208). You can
use the QUHRHLPT API to generate XML source representing the help text as
defined in help identifiers in UIM panel groups or menus.</p>
<p>The QUHRHLPT API returns information in one format.</p>
<p><strong>Special consideration:</strong> The text for the UIM LINK tag will
be displayed, but there will be no link generated in the XML source.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Help Panel Group/Menu Authority</em></dt>
<dd>*READ</dd>
<dt><em>Help Panel Group/Menu Library Authority</em></dt>
<dd>*EXECUTE</dd>
<dt><em>Imported Help Panel Group Authority</em></dt>
<dd>*READ</dd>
<dt><em>Imported Help Panel Group Library Authority</em></dt>
<dd>*EXECUTE</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>INPUT; CHAR(*)
<p>The variable that is to receive the information requested. For the format of
the structure, see <a href="#RHLP01002">Format of the receiver
variable</a>.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable. If the length is larger than the size
of the receiver variable, the results may be unpredictable. The minimum length
is 8 bytes.</p>
</dd>
<dt><strong>Format name</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the information returned for the help identifiers that are
requested. The following format name must be used:</p>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>RHLP0100</em></td>
</tr>
</table>
<p>For details about the formats, see <a href="#RHLP01002">Format of the
receiver variable</a>.</p>
</dd>
<dt><strong>Help identifiers to be retrieved</strong></dt>
<dd>INPUT; Array(*) of (*)
<p>An array of help identifiers to be formatted. The list can contain up to
2000 items. For the format of the structure, see <a href="#RHLP01001">Format of
help identifiers to be retrieved</a>.</p>
</dd>
<dt><strong>Number of help identifiers</strong></dt>
<dd>INPUT; BINARY(4)
<p>The number of help identifer names passed in on the help identifiers to be
retrieved parameter.</p>
</dd>
<dt><strong>Help identifier text</strong></dt>
<dd>OUTPUT; Char(*)
<p>The variable that is to receive the generated Xml output. The information
returned potentially could be very large. In this case, a user space with the
auto-extendable attribute set may act as a better choice for a receiver
variable. For further information about using a user space, see
<a href="../apiref/listUserSpace.htm">User spaces for list APIs</a> in API concepts.
For the format of the structure, see <a href="#RHLP01003">Format of help identifier
text</a>. If the variable is not large enough, no data may be returned.</p>
</dd>
<dt><strong>Length of help identifier text</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the help identifier text parameter. If the length specified is
larger than the size of the parameter, the results may be undesirable. The
minimum length is 8 bytes.</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>. If this
parameter is omitted, diagnostic and escape messages are issued to the
application.</p>
</dd>
</dl>
<br>
<h3><a name="RHLP01002">Format of the receiver variable</a></h3>
<p>The receiver variable contains:</p>
<ul>
<li>A header section</li>
<li>A list data section</li>
</ul>
<p>For detailed descriptions of each field in the header section, see <a href=
"#RHLPFD_3">Field Descriptions</a>.</p>
<h4>RHLP0100</h4>
<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">CHAR(8)</td>
<td align="left" valign="top">Format name</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">Offset to help identifiers</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">Number of entries</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">Size of each entry</td>
</tr>
<tr>
<td align="center" valign="top">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">CHAR(*)</td>
<td align="left" valign="top">Help identifiers</td>
</tr>
</table>
<br>
<br>
<h4>Help identifier entries</h4>
<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%">Help identifier name</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">Object name</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object library name</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(1)</td>
<td align="left" valign="top">Help identifier found</td>
</tr>
<tr>
<td align="center" valign="top">63</td>
<td align="center" valign="top">3F</td>
<td align="left" valign="top">CHAR(96)</td>
<td align="left" valign="top">Help identifier anchor name</td>
</tr>
<tr>
<td align="center" valign="top">167</td>
<td align="center" valign="top">A7</td>
<td align="left" valign="top">CHAR(33)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="RHLPFD_3">Field Descriptions</a></h3>
<p><strong>Bytes available.</strong> The number of bytes of information
available to be returned.</p>
<p><strong>Bytes returned.</strong> The number of bytes of information
returned.</p>
<p><strong>Format name.</strong> The format name that was passed to this
API.</p>
<p><strong>Help identifier anchor name.</strong> The name of the anchor within
the help document.</p>
<p><strong>Help identifier found.</strong> A one-character field indicating the
status of the help ID when the caller selects the help identifiers to be
retrieved. The possible values are:</p>
<table cellpadding="5">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">Not found due to incorrect name</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Help identifier found</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">Object access failure; see joblog for
details</td>
</tr>
</table>
<p>If none of the requested help identifiers are found, the API will also
signal a CPF6E3B escape message.</p>
<p><strong>Help identifier name.</strong> The name specified on the NAME
attribute of a :HELP. tag in the panel group or menu object.</p>
<p><strong>Number of entries.</strong> The number of entries being returned in
the list data section.</p>
<p><strong>Object library name.</strong> The library containing the panel group
or menu object in which the help identifier was found.</p>
<p><strong>Object name.</strong> A 10-character name used to identify the panel
group or menu object in which the help identifier was found.</p>
<p><strong>Object type.</strong> The type of the object in which the help
identifier was found.</p>
<p><strong>Offset to help identifiers.</strong> The offset from the start of
the receiver variable to the first help identifier.</p>
<p><strong>Reserved.</strong> An ignored field.</p>
<p><strong>Size of each entry.</strong> The size of each entry in bytes in the
list data section.</p>
<br>
<h3><a name="RHLP01001">Format of help identifiers to be retrieved</a></h3>
<p>The following information is accepted as input. For detailed descriptions of
the fields in the table, see <a href="#RHLPFD_2">Field Descriptions</a>.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="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%">Help identifier name</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">Object name</td>
</tr>
<tr>
<td align="center" valign="top">42</td>
<td align="center" valign="top">2A</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object library name</td>
</tr>
<tr>
<td align="center" valign="top">52</td>
<td align="center" valign="top">34</td>
<td align="left" valign="top">CHAR(10)</td>
<td align="left" valign="top">Object type</td>
</tr>
<tr>
<td align="center" valign="top">62</td>
<td align="center" valign="top">3E</td>
<td align="left" valign="top">CHAR(18)</td>
<td align="left" valign="top">Reserved</td>
</tr>
</table>
<br>
<br>
<h3><a name="RHLPFD_2">Field Descriptions</a></h3>
<p><strong>Help identifier name.</strong> The name specified on the NAME
attribute of a :HELP. tag in the panel group or menu object. The name must be
specified using uppercase, alphabetic characters.</p>
<p><strong>Object library name.</strong> The library containing the panel group
or menu object in which the help identifier was found. As input, this value
must be in uppercase letters. 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>
<p><strong>Object name.</strong> A 10-character name used to identify the panel
group or menu object in which the help identifier was found. As input, this
value must be in uppercase letters.</p>
<p><strong>Object type.</strong> The type of the object in which the help
identifier was found. This value must be *PNLGRP or *MENU.</p>
<p><strong>Reserved.</strong> This field should be set to blanks.</p>
<br>
<h3><a name="RHLP01003">Format of the help identifier text</a></h3>
<p>The following is a description of the data in the help identifier text
parameter.</p>
<table border width="80%">
<tr>
<th align="center" valign="bottom" colspan="2">Offset</th>
<th align="left" valign="bottom" rowspan="2">Type</th>
<th align="left" valign="bottom" rowspan="2">Field</th>
</tr>
<tr>
<th align="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">*</td>
<td align="center" valign="top">*</td>
<td align="left" valign="top">Char(*)</td>
<td align="left" valign="top">Data</td>
</tr>
</table>
<br>
<br>
<h3><a name="RHLPFD_1">Field Descriptions</a></h3>
<p><strong>Bytes available.</strong> The number of bytes of information
available to be returned.</p>
<p><strong>Bytes returned.</strong> The number of bytes of information
returned.</p>
<p><strong>Data.</strong> The UIM online help formatted in Xml. This
information contains:</p>
<ul>
<li>A document header section</li>
<li>Xml-formatted tags</li>
<li>A document footer section</li>
</ul>
<p>Each formatted help
identifier contains a &lt;div&gt; tag representing the help identifier being
formatted, such as:</p>
<ul>
<li>&lt;div&gt; &lt;a name="FSDIR.CRTDIR"&gt;&lt;/a&gt;</li>
<li>&nbsp; (Xml-formatted help text is contained here)</li>
<li>&lt;/div&gt;</li>
</ul>
<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 width="15%" valign="top">CPF24B4 E</td>
<td width="85%" valign="top">Severe error while addressing parameter list.</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">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C20 E</td>
<td align="left" valign="top">Error found by program &amp;1.</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 receiver variable not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C31 D</td>
<td align="left" valign="top">Object type &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C36 E</td>
<td align="left" valign="top">Number of parameters, &amp;1, entered for this
API was not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 D</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 D</td>
<td align="left" valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF6E3B E</td>
<td align="left" valign="top">Help information is not available.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 D</td>
<td align="left" valign="top">Cannot allocate object &amp;2 in library
&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9804 D</td>
<td align="left" valign="top">Object &amp;2 in library &amp;3 damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 D</td>
<td align="left" valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 D</td>
<td align="left" valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9838 E</td>
<td align="left" valign="top">User profile storage limit exceeded.</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: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"uim1.htm">User Interface Manager (UIM) APIs</a> | <a href="aplist.htm">APIs by
category</a> </td>
</tr>
</table>
</center>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink