117 lines
6.8 KiB
HTML
117 lines
6.8 KiB
HTML
|
<?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="HLPRTN (Help Return) keyword for display files" />
|
||
|
|
<meta name="abstract" content="Use this file- or record-level keyword to return control to your program when you press the Help key." />
|
||
|
|
<meta name="description" content="Use this file- or record-level keyword to return control to your program when you press the Help key." />
|
||
|
|
<meta name="DC.subject" content="HLPRTN (Help Return) keyword, Help Return (HLPRTN) keyword" />
|
||
|
|
<meta name="keywords" content="HLPRTN (Help Return) keyword, Help Return (HLPRTN) keyword" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzakcmstkeyent.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzakcmstdfhelp.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="rzakcmstdfhprtn" />
|
||
|
|
<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>HLPRTN (Help Return) keyword for display files</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzakcmstdfhprtn"><a name="rzakcmstdfhprtn"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">HLPRTN (Help Return) keyword for display files</h1>
|
||
|
|
<div><p>Use this file- or record-level keyword to return control to your
|
||
|
|
program when you press the Help key.</p>
|
||
|
|
<div class="section"><p>If HLPRTN is not specified, online help information associated
|
||
|
|
with the current cursor location is displayed.</p>
|
||
|
|
<p>See the <a href="s36env.htm">System/36 environment considerations for display files</a> topic
|
||
|
|
for special considerations when specifying the HLPRTN keyword in files that
|
||
|
|
are used in the System/36™ environment.</p>
|
||
|
|
<div class="p">The
|
||
|
|
format of the keyword is: <pre>HLPRTN[(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 computer printout 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 computer printout.</p>
|
||
|
|
<p>HLPRTN
|
||
|
|
at either the file or record level takes priority over any HLPRCD, HLPPNLGRP,
|
||
|
|
or HLPDOC keywords. Any HLPRTN keyword found in the file is processed before
|
||
|
|
any other applicable help keyword.</p>
|
||
|
|
<div class="p">When you specify HLPRTN, control
|
||
|
|
might or might not return to your program, depending on whether you use an
|
||
|
|
option indicator: <ul><li>If you specify HLPRTN without an option indicator, control returns to
|
||
|
|
your program when you press the Help key. A warning message appears at creation
|
||
|
|
time if you specify an unoptioned HLPRTN keyword on a file or record containing
|
||
|
|
H specifications.</li>
|
||
|
|
<li>If you specify HLPRTN with an option indicator, control returns to your
|
||
|
|
program if the option indicator is on at the time the record is displayed.
|
||
|
|
The H specifications are used if the option indicator is off.</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<p>Option indicators are valid for this keyword.</p>
|
||
|
|
</div>
|
||
|
|
<div class="example"><h4 class="sectiontitle">Example 1</h4><p>The following example shows how to use
|
||
|
|
the HLPRTN keyword.</p>
|
||
|
|
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
|
||
|
|
A HELP
|
||
|
|
A HLPRCD(GENERAL)
|
||
|
|
A R RECORD1
|
||
|
|
A 02 HLPRTN
|
||
|
|
A H HLPARA(1 1 3 10)
|
||
|
|
A HLPRCD(HELPREC1)
|
||
|
|
A FIELD1 10A B 2 2
|
||
|
|
A R RECORD2 HLPRTN
|
||
|
|
A FIELDA 5A B 10 7
|
||
|
|
A</pre>
|
||
|
|
<p>If indicator 02 is on when RECORD1 is written to the
|
||
|
|
display, control will return to the user program when the Help key is pressed.
|
||
|
|
If indicator 02 is off, online help information record HELPREC1 or GENERAL
|
||
|
|
will be displayed when the Help key is pressed, depending on the position
|
||
|
|
of the cursor. When RECORD2 is displayed, control will return to the user
|
||
|
|
program when the Help key is pressed.</p>
|
||
|
|
</div>
|
||
|
|
<div class="example"><h4 class="sectiontitle">Example 2</h4> <pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
|
||
|
|
A HELP
|
||
|
|
A 01 HLPRTN
|
||
|
|
A HLPRCD(GENERAL)
|
||
|
|
A R RECORD1
|
||
|
|
A H HLPARA(1 1 3 10)
|
||
|
|
A HLPRCD(HELPREC1)
|
||
|
|
A FIELD1 10A B 2 2
|
||
|
|
A R RECORD2
|
||
|
|
A FIELDA 5A B 10 7
|
||
|
|
A</pre>
|
||
|
|
<p>If indicator 01 is on, control returns to your program
|
||
|
|
when you press the Help key regardless of the cursor position.</p>
|
||
|
|
</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="rzakcmstdfhelp.htm" title="Use this file- or record-level keyword to enable the Help key.">HELP (Help) 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>
|