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

144 lines
8.1 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 keyword" />
<meta name="abstract" content="This topic describes MSGID keyword." />
<meta name="description" content="This topic describes MSGID keyword." />
<meta name="DC.subject" content="System/36 environment, MSGID (Message Identifier) keyword, MSGID (Message Identifier) keyword, in the System/36 environment" />
<meta name="keywords" content="System/36 environment, MSGID (Message Identifier) keyword, MSGID (Message Identifier) keyword, in the System/36 environment" />
<meta name="DC.Relation" scheme="URI" content="keycons.htm" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstdfmsgid.htm" />
<meta name="DC.Relation" scheme="URI" content="rzakcmstdfmsgid.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="msfidf" />
<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 keyword</title>
</head>
<body id="msfidf"><a name="msfidf"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">MSGID keyword</h1>
<div><p>This topic describes MSGID keyword.</p>
<div class="section"><div class="p">You can specify the MSGID keyword in either of the following formats:<pre>MSGID(message-identifier [library-name/]message-file)
MSGID(*NONE)</pre>
</div>
<p>You can specify the message-file parameter
in one of the following forms:</p>
<ul><li><samp class="codeph">&amp;field3</samp> <p>where the field3 length is two (2).</p>
<p>The
field name must exist in the same record as the MSGID field, and the field
must be defined as a character field with usage H, P, B, or O.</p>
<p>You should,
for this form only, specify only special values for the file parameter. You
cannot specify a library.</p>
<p>The special values are: U1, U2, P1, P2, M1,
and M2. If the specified value is not one of these special values, U1 is used.
See <a href="#msfidf__spval">Table 1</a> for more information about these values.</p>
</li>
<li>Special values for message-file: <ul><li>*USR1</li>
<li>*USR2</li>
<li>*PGM1</li>
<li>*PGM2</li>
<li>*SYS1</li>
<li>*SYS2</li>
</ul>
<p>When you code a special value for the message-file,
the library parameter is not allowed and the library is set to *LIBL as default.
See <a href="#msfidf__spval">Table 1</a> for more information about these special
values.</p>
</li>
</ul>
<p>The following table describes the meaning of the special file values
for the MSGID keyword.</p>
<div class="tablenoborder"><a name="msfidf__spval"><!-- --></a><table cellpadding="4" cellspacing="0" summary="" id="msfidf__spval" width="100%" frame="border" border="1" rules="all"><caption>Table 1. Special values on MSGID keyword</caption><thead align="left"><tr><th valign="top" width="33.33333333333333%" id="d0e81">DDS special value</th>
<th valign="top" width="33.33333333333333%" id="d0e83">Length 2 field value</th>
<th valign="top" width="33.33333333333333%" id="d0e85">Message text retrieved</th>
</tr>
</thead>
<tbody><tr><td valign="top" width="33.33333333333333%" headers="d0e81 ">*USR1</td>
<td valign="top" width="33.33333333333333%" headers="d0e83 ">U1</td>
<td valign="top" width="33.33333333333333%" headers="d0e85 ">First level text from message file USR1</td>
</tr>
<tr><td valign="top" width="33.33333333333333%" headers="d0e81 ">*USR2</td>
<td valign="top" width="33.33333333333333%" headers="d0e83 ">U2</td>
<td valign="top" width="33.33333333333333%" headers="d0e85 ">Second level text from message file USR2</td>
</tr>
<tr><td valign="top" width="33.33333333333333%" headers="d0e81 ">*PGM1</td>
<td valign="top" width="33.33333333333333%" headers="d0e83 ">P1</td>
<td valign="top" width="33.33333333333333%" headers="d0e85 ">First level text from message file PGM1</td>
</tr>
<tr><td valign="top" width="33.33333333333333%" headers="d0e81 ">*PGM2</td>
<td valign="top" width="33.33333333333333%" headers="d0e83 ">P2</td>
<td valign="top" width="33.33333333333333%" headers="d0e85 ">Second level text from message file PGM2</td>
</tr>
<tr><td valign="top" width="33.33333333333333%" headers="d0e81 ">*SYS1</td>
<td valign="top" width="33.33333333333333%" headers="d0e83 ">M1</td>
<td valign="top" width="33.33333333333333%" headers="d0e85 ">First level text from message file SYS1</td>
</tr>
<tr><td valign="top" width="33.33333333333333%" headers="d0e81 ">*SYS2</td>
<td valign="top" width="33.33333333333333%" headers="d0e83 ">M2</td>
<td valign="top" width="33.33333333333333%" headers="d0e85 ">Second level text from message file SYS2</td>
</tr>
</tbody>
</table>
</div>
<p>For information about using message retrieval, see the <a href="../books/sc415715.pdf" target="_blank">Application Display Programming
book</a><img src="wbpdf.gif" alt="Link to PDF" />.</p>
<p>The
*NONE parameter indicates that no message text is displayed.</p>
<p>The following
example shows how to specify the MSGID keyword.</p>
</div>
<div class="example"> <pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
A R RECORD1
A MSGFIELD1 40A B 02 10MSGID(CPD0001 *USR1)
A MSGFIELD2 10A O 02 60MSGID(&amp;MSGIDNUM &amp;MSGFILENM);
A MSGFIELD3 80A B 02 60
A 99 MSGID(USR &amp;MSGNBR +
A &amp;MSGFILENM);
A MSGID(*NONE)
A MSGIDNUM 7A P TEXT('Message id')
A MSGFILENM 2A P TEXT('Message file name')
A MSGNBR 4A P 07 01TEXT('Message number')
A</pre>
<p>When RECORD1 is displayed:</p>
<ul><li>MSGFIELD1 contains the first 40 characters of the message CPD0001 from
the message file USR1. Because the field is input/output (usage B), the value
of the field can be changed by the user.</li>
<li>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. Because MSGFIELD2 is an output-only field (usage O), it cannot
be used in the program.</li>
<li>If option indicator 99 is on, 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. If option indicator 99
is off, MSGFIELD3 does not contain any message text.</li>
</ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="keycons.htm" title="Some keywords in a display file containing USRDSPMGT cannot be specified.">Keyword considerations for display files used in the System/36 environment</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="rzakcmstdfmsgid.htm" title="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.">MSGID (Message Identifier) keyword for display files</a></div>
</div>
</div>
</body>
</html>