169 lines
9.5 KiB
HTML
169 lines
9.5 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="MSGID (Message Identifier) keyword for display files" />
|
||
|
|
<meta name="abstract" content="Use this field-level keyword to allow an application program to identify, at program run time, the message description that contains text for a named field." />
|
||
|
|
<meta name="description" content="Use this field-level keyword to allow an application program to identify, at program run time, the message description that contains text for a named field." />
|
||
|
|
<meta name="DC.subject" content="MSGID (Message Identifier) keyword, Message Identifier (MSGID) keyword" />
|
||
|
|
<meta name="keywords" content="MSGID (Message Identifier) keyword, Message Identifier (MSGID) keyword" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzakcmstkeyent.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="msfidf.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="msfidf.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="rzakcmstdfmsgid" />
|
||
|
|
<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>MSGID (Message Identifier) keyword for display files</title>
|
||
|
|
</head>
|
||
|
|
<body id="rzakcmstdfmsgid"><a name="rzakcmstdfmsgid"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">MSGID (Message Identifier) keyword for display files</h1>
|
||
|
|
<div><p>Use this field-level keyword to allow an application program to
|
||
|
|
identify, at program run time, the message description that contains text
|
||
|
|
for a named field.</p>
|
||
|
|
<div class="section"><p>The parameter values on this keyword can specify
|
||
|
|
fields that contain the message identifier, message file, and library. After
|
||
|
|
the program sets the fields to the values you want, an output operation causes
|
||
|
|
the message to be retrieved from the message file and displayed. The retrieved
|
||
|
|
message is truncated if it is longer than the MSGID field. The retrieved message
|
||
|
|
is padded with blanks if it is shorter than the MSGID field.</p>
|
||
|
|
<p>See the <a href="s36env.htm">System/36 environment considerations for display files</a> topic for information about how to specify the
|
||
|
|
MSGID keyword in files that are used in the System/36™ environment.</p>
|
||
|
|
<div class="p">The format
|
||
|
|
of the keyword is: <pre>MSGID(message-identifier [library-name/]message-file)
|
||
|
|
<strong>or</strong>
|
||
|
|
MSGID(*NONE)</pre>
|
||
|
|
</div>
|
||
|
|
<div class="p">The message-identifier parameter describes
|
||
|
|
the message description containing the text for the named field. You can specify
|
||
|
|
this parameter in one of two ways: <ul><li><samp class="codeph">[msg-prefix] &field-name</samp> <p>A message-prefix and
|
||
|
|
a field-name. The field-name must exist in the same record format as the MSGID
|
||
|
|
field. If you specify a prefix, the length of the prefix must be three, and
|
||
|
|
you must define the field-name as a character field of length four (4), and
|
||
|
|
usage H, P, B, or O. If you do not specify a prefix, you must define the field-name
|
||
|
|
as a character field length of seven (7), and usage H, P, B, or O.</p>
|
||
|
|
</li>
|
||
|
|
<li><samp class="codeph">[msgid-prefix] msg-id</samp> <p>You can also use a value or
|
||
|
|
a combination of values to specify the message identifier. If you specify
|
||
|
|
a prefix, the prefix length must be three (3), and the msg-id length must
|
||
|
|
be four (4). If you do not specify a prefix, the msg-id length must be seven
|
||
|
|
(7).</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<p>The message-identifier is a required parameter.</p>
|
||
|
|
<div class="p">The message-file
|
||
|
|
and library parameters identify the message file containing the message description.
|
||
|
|
You can specify the message-file and library parameters in one of the following
|
||
|
|
forms: <ul><li><samp class="codeph">[library-name/]file-name</samp></li>
|
||
|
|
<li><samp class="codeph">[&field1/]&field2</samp> <p>where the lengths of field1
|
||
|
|
and field2 are ten (10).</p>
|
||
|
|
<p>The field names must exist in the same record
|
||
|
|
format as the MSGID field, and the fields must be defined as having character
|
||
|
|
lengths of ten (10) and usage H, P, B, or O.</p>
|
||
|
|
</li>
|
||
|
|
<li>Combination of field names and constants: <ul><li><samp class="codeph">library-name/&field1</samp> (length of field1 is 10)</li>
|
||
|
|
<li><samp class="codeph">&field2/file-name</samp> (length of field2 is 10)</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<p>The message-file is a required parameter. If you do not specify
|
||
|
|
the library parameter, *LIBL is used to search for the message file at program
|
||
|
|
runtime. The library is an optional parameter.</p>
|
||
|
|
<p>The *NONE parameter indicates
|
||
|
|
that no message text is to be displayed.</p>
|
||
|
|
<p>The user or program can override
|
||
|
|
the message file name by using the OVRMSGF command.</p>
|
||
|
|
<p>You can specify
|
||
|
|
multiple MSGID keywords on a field. When more than one MSGID keyword is specified,
|
||
|
|
option indicators are required on all except the last MSGID keyword on a field.
|
||
|
|
Option indicators are not allowed on the last (or only) MSGID keyword specified
|
||
|
|
on a field. If more than one MSGID keyword is in effect for a field, the first
|
||
|
|
MSGID specified is used.</p>
|
||
|
|
<p>You can specify multiple MSGID keywords within
|
||
|
|
a record format. You can specify field names used as parameters on more than
|
||
|
|
one MSGID keyword.</p>
|
||
|
|
<p>You must have use authority to the message file at
|
||
|
|
program runtime.</p>
|
||
|
|
<p>The MSGID field must be output-capable (usage B or
|
||
|
|
O). The length specified for the field is the length of the message text that
|
||
|
|
is to be displayed. It should be the length of the longest message to be displayed.</p>
|
||
|
|
<p>The
|
||
|
|
MSGID field itself does not appear in the output buffer, but it does appear
|
||
|
|
in the input buffer if it is defined as input/output (usage B). MSGID fields
|
||
|
|
that are defined as output-only cannot be used in high-level language programs.</p>
|
||
|
|
<p>The
|
||
|
|
MSGID parameter fields (if any) appear in the output buffer, but they appear
|
||
|
|
in the input buffer only if they are defined as hidden or input/output (usage
|
||
|
|
H or B) fields.</p>
|
||
|
|
<p>A program-to-system field can be specified as the message-id,
|
||
|
|
file, or library name.</p>
|
||
|
|
<p>You cannot specify MSGID in a subfile record
|
||
|
|
format (SFL keyword).</p>
|
||
|
|
<p>The following keywords cannot be specified on
|
||
|
|
a field with the MSGID keyword:</p>
|
||
|
|
<p>DFT<br />
|
||
|
|
DFTVAL<br />
|
||
|
|
FLTFIXDEC<br />
|
||
|
|
FLTPCN<br />
|
||
|
|
MSGCON</p>
|
||
|
|
</div>
|
||
|
|
<div class="example"><h4 class="sectiontitle">Example</h4><p>The following example shows how to specify
|
||
|
|
the MSGID keyword.</p>
|
||
|
|
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
|
||
|
|
A R RECORD1
|
||
|
|
A MSGFIELD1 40A B 02 10MSGID(CPD0001 QGPL/USRMSG)
|
||
|
|
A 01 MSGFIELD2 10A O 02 60
|
||
|
|
A 25 MSGID(&MSGIDNUM &MSGFILENM);
|
||
|
|
A MSGID(CPD1234 QGPL/USRMSG)
|
||
|
|
A MSGFIELD3 80A B 02 60
|
||
|
|
A MSGID(USR &MSGNBR +
|
||
|
|
A QGPL/&MSGGILENM);
|
||
|
|
A MSGIDNUM 7A P
|
||
|
|
A MSGFILENM 10A H
|
||
|
|
A MSGNBR 4A B 07 01
|
||
|
|
A</pre>
|
||
|
|
<div class="p">When RECORD1 is displayed: <ul><li>MSGFIELD1 contains the first 40 characters of the message CPD0001 from
|
||
|
|
the message file USRMSG in library QGPL. Since the field is input/output (usage
|
||
|
|
B), the value of the field can be changed by the user.</li>
|
||
|
|
<li>If option indicator 01 is off, MSGFIELD2 is not displayed. When option
|
||
|
|
indicators 01 and 25 are on, MSGFIELD2 contains the first 10 characters of
|
||
|
|
the message identified by the fields MSGIDNUM and MSGFILENM. Values for MSGIDNUM
|
||
|
|
(the message identifier) and MSGFILENM (the message file) must be set in the
|
||
|
|
program before the display of RECORD1. <p>When option indicator 01 is on but
|
||
|
|
option indicator 25 is off, MSGFIELD2 contains the first 10 characters of
|
||
|
|
message CPD1234 from the message file USRMSG in library QGPL. Since MSGFIELD2
|
||
|
|
is an output-only field (usage O), it cannot be used in the program.</p>
|
||
|
|
</li>
|
||
|
|
<li>MSGFIELD3 contains the first 80 characters of the message identified by
|
||
|
|
the prefix USR, the message number set in field MSGNBR, and the message file
|
||
|
|
set in field MSGFILENM.</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</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="msfidf.htm" title="This topic describes MSGID keyword.">MSGID keyword</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|