ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/dsphlpdoc.htm

137 lines
4.3 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Display Help Document (DSPHLPDOC)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="DSPHLPDOC.Top_Of_Page"></a>
<h2>Display Help Document (DSPHLPDOC)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>Interactive environments (*INTERACT *IPGM *IREXX *EXEC)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#DSPHLPDOC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#DSPHLPDOC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#DSPHLPDOC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="DSPHLPDOC"></a>
<p>The Display Help Document (DSPHLPDOC) command displays help information as a document in its final form. The document is created using the word processing function of the OfficeVision/400 product.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPHLPDOC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="DSPHLPDOC.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#DSPHLPDOC.DOC"><b>DOC</b></a></td>
<td valign="top">Document</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#DSPHLPDOC.FLR"><b>FLR</b></a></td>
<td valign="top">Folder</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#DSPHLPDOC.HLPLBL"><b>HLPLBL</b></a></td>
<td valign="top">Help text label</td>
<td valign="top"><i>Character value</i>, <b><u>*FIRST</u></b></td>
<td valign="top">Optional, Positional 3</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#DSPHLPDOC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="DSPHLPDOC.DOC"></a>
<h3>Document (DOC)</h3>
<p>Specifies the name of the help document you want displayed. The help document must be a resolved document.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPHLPDOC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPHLPDOC.FLR"></a>
<h3>Folder (FLR)</h3>
<p>Specifies the name of the folder that contains the help document to be displayed.
</p>
<p>This is a required parameter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPHLPDOC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="DSPHLPDOC.HLPLBL"></a>
<h3>Help text label (HLPLBL)</h3>
<p>Specifies where to start displaying the document. The user can use the page or roll keys or other positioning requests to look for the information.
</p>
<dl>
<dt><b><u>*FIRST</u></b></dt>
<dd>The document is displayed at the start of the first page.
</dd>
<dt><b><i>help-label-name</i></b></dt>
<dd>Specify the name of the label used as the starting point for displaying the document.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPHLPDOC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPHLPDOC.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
DSPHLPDOC DOC(KDOC) FLR(NFLR) HLPLBL(*FIRST)
</pre>
</p>
<p>This command uses the document KDOC in folder NFLR as the help document.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPHLPDOC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="DSPHLPDOC.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>OFC87B2</b></dt>
<dd>The help document could not be opened.
</dd>
<dt><b>OFC9040</b></dt>
<dd>Help text label not found.
</dd>
<dt><b>OFC9041</b></dt>
<dd>Document is not final form.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#DSPHLPDOC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>