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

447 lines
15 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Change Menu (CHGMNU)</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="CHGMNU.Top_Of_Page"></a>
<h2>Change Menu (CHGMNU)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#CHGMNU.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CHGMNU.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CHGMNU.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CHGMNU"></a>
<p>The Change Menu (CHGMNU) command can be used to change the following:
</p>
<ul>
<li>Current library and product library of a menu
</li>
<li>Display file name and library of a display file menu
</li>
<li>Message file name and library of a display file menu
</li>
<li>Whether a long command line, a short command line, or no command line (an option line) is displayed for a display file menu
</li>
<li>Whether a description of the active function keys is shown for a display file menu
</li>
<li>Program name and library of a program menu
</li>
<li>Text description of a menu
</li>
</ul>
<p><b>Restrictions:</b>
</p>
<ul>
<li>You must have opbject operational (*OBJOPR) and object management (*OBJMGT) authorities for the menu object, and use (*USE) authority for the library where the menu object is located.
</li>
</ul>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CHGMNU.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" rowspan="3"><a href="#CHGMNU.MENU"><b>MENU</b></a></td>
<td valign="top">Menu</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Required, Key, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Menu</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#CHGMNU.DSPF"><b>DSPF</b></a></td>
<td valign="top">Display file</td>
<td valign="top">Single values: <b><u>*SAME</u></b><br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Display file</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#CHGMNU.MSGF"><b>MSGF</b></a></td>
<td valign="top">Message file</td>
<td valign="top">Single values: <b><u>*SAME</u></b><br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Message file</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#CHGMNU.CMDLIN"><b>CMDLIN</b></a></td>
<td valign="top">Command line</td>
<td valign="top"><b><u>*SAME</u></b>, *LONG, *SHORT, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CHGMNU.DSPKEY"><b>DSPKEY</b></a></td>
<td valign="top">Display function keys</td>
<td valign="top"><b><u>*SAME</u></b>, *NO, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CHGMNU.PGM"><b>PGM</b></a></td>
<td valign="top">Program</td>
<td valign="top">Single values: <b><u>*SAME</u></b><br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Program</td>
<td valign="top"><i>Name</i></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*LIBL</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#CHGMNU.CURLIB"><b>CURLIB</b></a></td>
<td valign="top">Current library</td>
<td valign="top"><i>Name</i>, <b><u>*SAME</u></b>, *NOCHG, *MNULIB, *CRTDFT</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CHGMNU.PRDLIB"><b>PRDLIB</b></a></td>
<td valign="top">Product library</td>
<td valign="top"><i>Name</i>, <b><u>*SAME</u></b>, *NOCHG, *NONE</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CHGMNU.TEXT"><b>TEXT</b></a></td>
<td valign="top">Text 'description'</td>
<td valign="top"><i>Character value</i>, <b><u>*SAME</u></b>, *BLANK</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CHGMNU.MENU"></a>
<h3>Menu (MENU)</h3>
<p>Specifies the menu to be changed.
</p>
<p>This is a required parameter.
</p>
<p><b>Qualifier 1: Menu</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the menu object.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the menu. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the library where the menu is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGMNU.DSPF"></a>
<h3>Display file (DSPF)</h3>
<p>Specifies the display file used for the menu. The display file must include one record format with the same name as the display file itself, called the menu format. Help formats can also be included in the file.
</p>
<p>Help formats follow the naming convention <b>#Hxxyy</b>, where xx is the first menu option and yy is the last menu option to which the help format applies. (For example, #H0306 would apply to menu options 3 through 6.) <b>#H0000</b> designates the general help for the menu.
</p>
<p>This parameter can be specified only if the menu was created with *DSPF specified for the <b>Menu type (TYPE)</b> parameter on the Create Menu (CRTMNU) command.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The display file name and library do not change.
</dd>
</dl>
<p><b>Qualifier 1: Display file</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the display file to be used.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the display file. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the library where the display file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGMNU.MSGF"></a>
<h3>Message file (MSGF)</h3>
<p>Specifies the message file that contains the commands to run when a menu option is selected. The MSGID's of the messages in this file are of the form USRxxxx, where xxxx is the number of the menu option that is typed on the command line.
</p>
<p>This parameter can be specified only if the menu was created with *DSPF specified for the <b>Menu type (TYPE)</b> parameter on the Create Menu (CRTMNU) command.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The message file name and library do not change.
</dd>
</dl>
<p><b>Qualifier 1: Message file</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the message file to be used.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the message file. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the library where the message file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGMNU.CMDLIN"></a>
<h3>Command line (CMDLIN)</h3>
<p>Specifies whether a long command line, a short command line, or no command line (an option line) is used.
</p>
<p>This parameter can be specified only if the menu was created with *DSPF specified for the <b>Menu type (TYPE)</b> parameter on the Create Menu (CRTMNU) command.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The command line or option line remains the same.
</dd>
<dt><b>*LONG</b></dt>
<dd>A 153-byte long command line is used.
</dd>
<dt><b>*SHORT</b></dt>
<dd>A 73-byte long command line is used.
</dd>
<dt><b>*NONE</b></dt>
<dd>No command line is used. A 4-byte option line is used.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGMNU.DSPKEY"></a>
<h3>Display function keys (DSPKEY)</h3>
<p>Specifies whether the function key legend appears at the bottom of the menu when the menu is shown.
</p>
<p>This parameter can be specified only if the menu was created with *DSPF specified for the <b>Menu type (TYPE)</b> parameter on the Create Menu (CRTMNU) command.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The function key legend does not change.
</dd>
<dt><b>*NO</b></dt>
<dd>The function key legend is not shown at the bottom of the display.
</dd>
<dt><b>*YES</b></dt>
<dd>The function key legend is shown at the bottom of the display.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGMNU.PGM"></a>
<h3>Program (PGM)</h3>
<p>Specifies the program to call when the menu is shown.
</p>
<p>This parameter can be specified only if the menu was created with *PGM specified for the <b>Menu type (TYPE)</b> parameter on the Create Menu (CRTMNU) command.
</p>
<p><b>Single values</b>
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The program name and library do not change.
</dd>
</dl>
<p><b>Qualifier 1: Program</b>
</p>
<dl>
<dt><b><i>name</i></b></dt>
<dd>Specify the name of the program to be called.
</dd>
</dl>
<p><b>Qualifier 2: Library</b>
</p>
<dl>
<dt><b><u>*LIBL</u></b></dt>
<dd>All libraries in the library list for the current thread are searched until the first match is found.
</dd>
</dl>
<dl>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the program. If no library is specified as the current library for the job, QGPL is used.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the library where the program is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGMNU.CURLIB"></a>
<h3>Current library (CURLIB)</h3>
<p>Specifies the library to be used as the current library when the menu is run.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The current library for the menu does not change.
</dd>
<dt><b>*NOCHG</b></dt>
<dd>The current library does not change for the processing of this menu.
</dd>
<dt><b>*MNULIB</b></dt>
<dd>The current library is changed to the library containing the menu while the menu is shown.
</dd>
<dt><b>*CRTDFT</b></dt>
<dd>There is no current library while the menu is shown. The current library that was active before the menu was shown (if any) is restored after exiting the menu.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the library name used as the current library when the menu is shown.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGMNU.PRDLIB"></a>
<h3>Product library (PRDLIB)</h3>
<p>Specifies the library to be used as the product library while the menu is shown.
</p>
<p>
<b>Note: </b>The product library for a command or menu remains in the library list while a command or menu is active, unless another command or menu changes the product library. When a command or menu that changed the product library ends, the product library is restored to what it was when the command or library started.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The product library for the menu does not change.
</dd>
<dt><b>*NOCHG</b></dt>
<dd>The product library is not changed when the menu is shown and is not restored after exiting the menu.
</dd>
<dt><b>*NONE</b></dt>
<dd>The product library entry in the library list is not used while the menu is shown.
</dd>
<dt><b><i>name</i></b></dt>
<dd>Specify the library name to use as the product library while the menu is shown.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CHGMNU.TEXT"></a>
<h3>Text 'description' (TEXT)</h3>
<p>Specifies the text that briefly describes the object.
</p>
<dl>
<dt><b><u>*SAME</u></b></dt>
<dd>The descriptive text does not change.
</dd>
<dt><b>*BLANK</b></dt>
<dd>No text is specified for the menu.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify no more than 50 characters of text, enclosed in apostrophes.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CHGMNU.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
CHGMNU MENU(ARLIB/ARPERS) PGM(ARLIB/PERSLIST)
</pre>
</p>
<p>This command changes the program that is called when a menu named ARPERS, located in library ARLIB, is run. The menu now calls a program called PERSLIST, also located in library ARLIB.
</p>
<p>Note that the menu (ARPERS) must have been created with TYPE(*PGM) specified on the Create Menu (CRTMNU) command for the PGM parameter to be specified here.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CHGMNU.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPF6ACD</b></dt>
<dd>Menu &amp;1 in &amp;2 is wrong version for system.
</dd>
<dt><b>CPF6AC2</b></dt>
<dd>Menu &amp;1 in library &amp;2 not changed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHGMNU.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>