ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzakc_5.4.0.1/rzakcmstdfhelp.htm

100 lines
6.1 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="HELP (Help) keyword for display files" />
<meta name="abstract" content="Use this file- or record-level keyword to enable the Help key." />
<meta name="description" content="Use this file- or record-level keyword to enable the Help key." />
<meta name="DC.subject" content="HELP (Help) keyword" />
<meta name="keywords" content="HELP (Help) keyword" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstkeyent.htm" />
<meta name="DC.Relation" scheme="URI" content="pos17.htm" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstdfalhlp.htm" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstdfhprtn.htm" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstdfhpara.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2001, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2001, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzakcmstdfhelp" />
<meta name="DC.Language" content="en-us" />
<!-- 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. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>HELP (Help) keyword for display files</title>
</head>
<body id="rzakcmstdfhelp"><a name="rzakcmstdfhelp"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">HELP (Help) keyword for display files</h1>
<div><p>Use this file- or record-level keyword to enable the Help key.</p>
<div class="section"><p>See the <a href="s36env.htm">System/36 environment considerations for display files</a> topic for special considerations
when specifying the HELP keyword in files that are used in the System/36™ environment.</p>
<div class="p">The
format of the keyword is: <pre>HELP[(response-indicator ['text'])]</pre>
</div>
<p>If
you specify a response indicator, the response indicator is set on and returned
to your program. No input data is transmitted from the device. Processing
is similar to that of a command attention key.</p>
<p>The optional text is
included on the listing created at program compilation time to explain the
intended use of the indicator. This text has no function in the file or program
other than as a comment. The single quotation marks are required. If you specify
more than 50 characters between the single quotation marks, the text is truncated
to 50 characters on the program list.</p>
<div class="p">One of the following actions occurs
when the Help key is pressed: <ul><li>Second level text for a message is displayed if the cursor is located
in a message subfile or on a field which specified either the ERRMSGID or
SFLMSGID keyword.</li>
<li>Online help information associated with either the entire display or an
area on the display. This function is indicated by H specifications (refer
to HLPARA (Help Area) keyword for display files) HLPDOC keyword.</li>
<li>Control is returned to the user's program. This occurs when there are
no H specifications or file-level HLPDOC, HLPPNLGRP, or HLPRCD keywords in
the file.</li>
</ul>
</div>
<p>If this keyword is not specified and the Help key is pressed,
the <span class="keyword">i5/OS™</span> operating system
issues an error message indicating that the Help key is not valid at that
time.</p>
<p>The HLPRTN keyword allows you to use option indicators to select
when online help information is displayed, and when control is returned to
the program.</p>
<p>When a response indicator is specified on the HELP keyword,
no H specifications or HLPRCD, HLPPNLGRP, HLPDOC, or HLPRTN keywords can be
specified in the file.</p>
<p>HELP (with no response indicator) is required
if the file contains H specifications or HLPRCD, HLPPNLGRP, HLPDOC, or HLPRTN
keywords.</p>
<p>Option indicators are valid for this keyword.</p>
</div>
<div class="example"><h4 class="sectiontitle">Example</h4><p>The following example shows how to specify
the HELP keyword.</p>
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
00024A HELP
A R RECORD1
A</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakcmstkeyent.htm" title="You type the keyword entries that define display files in positions 45 through 80 (functions).">DDS keyword entries for display files (positions 45 through 80)</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="pos17.htm" title="You can specify a value in this position to identify the type of name in positions 19 through 28.">Type of name or specification for display files (position 17)</a></div>
<div><a href="rzakcmstdfalhlp.htm" title="Use this file-level keyword to assign a command attention (CA) key as an alternative Help key.">ALTHELP (Alternative Help Key) keyword for display files</a></div>
<div><a href="rzakcmstdfhprtn.htm" title="Use this file- or record-level keyword to return control to your program when you press the Help key.">HLPRTN (Help Return) keyword for display files</a></div>
<div><a href="rzakcmstdfhpara.htm" title="Use this help-specification-level keyword to define a rectangular area on the display.">HLPARA (Help Area) keyword for display files</a></div>
</div>
</div>
</body>
</html>