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

484 lines
20 KiB
HTML
Raw 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>Create Menu from Msg Files (CRTMSGFMNU)</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="CRTMSGFMNU.Top_Of_Page"></a>
<h2>Create Menu from Msg Files (CRTMSGFMNU)</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="#CRTMSGFMNU.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CRTMSGFMNU.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CRTMSGFMNU.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CRTMSGFMNU"></a>
<p>The Create Message File Menu (CRTMSGFMNU) command creates a menu (display file) from the specified message files. You can specify that this menu is created either in a fixed-format, with options 1 through 24 arranged in two columns, or in free-format.
</p>
<p>If you want to create a menu from the source member, use the Create System/36 Menu (CRTS36MNU) command.
</p>
<p><b>Restriction</b>: Option 5 of the operating system must be installed to run this command. This command can be run either natively or in the System/36 environment.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CRTMSGFMNU.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="#CRTMSGFMNU.CMDTXTMSGF"><b>CMDTXTMSGF</b></a></td>
<td valign="top">Menu## command message file</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional, Positional 1</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Menu## command 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>*CURLIB</u></b></td>
</tr><tr>
<td valign="top" rowspan="3"><a href="#CRTMSGFMNU.OPTTXTMSGF"><b>OPTTXTMSGF</b></a></td>
<td valign="top">Option text message file</td>
<td valign="top">Single values: <b><u>*NONE</u></b><br>Other values: <i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional, Positional 2</td>
</tr>
<tr>
<td valign="top">Qualifier 1: Option text 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>*CMDLIB</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#CRTMSGFMNU.REPLACE"><b>REPLACE</b></a></td>
<td valign="top">Replace menu</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTMSGFMNU.FREEFORM"><b>FREEFORM</b></a></td>
<td valign="top">Free form menu</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTMSGFMNU.DDSLIST"><b>DDSLIST</b></a></td>
<td valign="top">DDS listing</td>
<td valign="top"><b><u>*PARTIAL</u></b>, *FULL</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTMSGFMNU.MAXDEV"><b>MAXDEV</b></a></td>
<td valign="top">Maximum devices</td>
<td valign="top">1-256, <b><u>5</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTMSGFMNU.AUT"><b>AUT</b></a></td>
<td valign="top">Authority</td>
<td valign="top"><i>Name</i>, *USE, *ALL, *CHANGE, *EXCLUDE, <b><u>*LIBCRTAUT</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top" rowspan="3"><a href="#CRTMSGFMNU.TOFILE"><b>TOFILE</b></a></td>
<td valign="top">To DDS source file</td>
<td valign="top"><i>Qualified object name</i></td>
<td valign="top" rowspan="3">Optional</td>
</tr>
<tr>
<td valign="top">Qualifier 1: To DDS source file</td>
<td valign="top"><i>Name</i>, <b><u>QDDSSRC</u></b></td>
</tr><tr>
<td valign="top">Qualifier 2: Library</td>
<td valign="top"><i>Name</i>, <b><u>*CMDLIB</u></b>, *CURLIB</td>
</tr><tr>
<td valign="top"><a href="#CRTMSGFMNU.TOMBR"><b>TOMBR</b></a></td>
<td valign="top">To DDS source member</td>
<td valign="top"><i>Name</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTMSGFMNU.IGCDTA"><b>IGCDTA</b></a></td>
<td valign="top">User specified DBCS data</td>
<td valign="top"><b><u>*NO</u></b>, *YES</td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#CRTMSGFMNU.TGTRLS"><b>TGTRLS</b></a></td>
<td valign="top">Target Release</td>
<td valign="top"><i>Character value</i>, <b><u>*CURRENT</u></b>, *PRV</td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CRTMSGFMNU.CMDTXTMSGF"></a>
<h3>Menu## command message file (CMDTXTMSGF)</h3>
<p>Specifies the name and library of the command text message file that contains the text for the command that runs when the corresponding option is selected. This parameter must identify an existing message file and not a screen file generator (SFGR) or a System/36 message source member. The message IDs used must begin with USR. Trailing ## symbols are required on the CMDTXTMSGF name. The menu (display file) name is the message-file-name without the ## symbols. The run-time menu processor appends the trailing ## symbols to the menu name to determine the message file name. This is the name of the message file that contains messages whose text is the command that is run for any option selected.
</p>
<p>This is a required parameter.
</p>
<dl>
<dt><b><i>message-file-name-##</i></b></dt>
<dd>Specify the message file name used to create the menu. The trailing ## symbols are required. The menu (display file) name is the same as the message file name without the ## symbols.
</dd>
</dl>
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*CURLIB</u></b></dt>
<dd>The current library for the job is used to locate the file. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library where the command text message file is located. The CMDTXTMSGF library is also where the menu display file is created. This is a requirement of the run-time MENU processor.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.OPTTXTMSGF"></a>
<h3>Option text message file (OPTTXTMSGF)</h3>
<p>Specifies the name and library of the option text message file that contains the text that is displayed on the menu to describe the options that can be selected. The message IDs used must begin with USR, unless *YES is specified on the <b>User specified DBCS data (IGCDTA)</b> parameter, which allows the message ID to begin with USZ.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No option text message file is used. The <b>Menu## command message file (CMDTXTMSGF)</b> parameter is used to specify the option text.
</dd>
<dt><b><i>message-file-name</i></b></dt>
<dd>Specify the name of the option text message file used for the descriptions of the options on the menu you are creating.
</dd>
</dl>
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*CMDLIB</u></b></dt>
<dd>The library specified on the Menu## command message file (CMDTXTMSGF) parameter is used to locate the option text message file.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the option text message file. If no library is specified as the current library for the job, the QGPL library is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library where the option text message file is located.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.REPLACE"></a>
<h3>Replace menu (REPLACE)</h3>
<p>Specifies whether the original display file is replaced by the new file.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>The existing display file does not change.
</dd>
<dt><b>*YES</b></dt>
<dd>The existing display file is replaced by the one being created. Other types of files are not replaced.
<p>
<b>Note: </b>The menu is not created if it has the same name and library as an existing program or message file.
</p>
<p>If terminating errors are encountered, the existing display file is not replaced. If the display file already exists, the <b>Authority (AUT)</b> parameter is ignored and the authorities for the old display file are copied to the new menu display file that replaces it.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.FREEFORM"></a>
<h3>Free form menu (FREEFORM)</h3>
<p>Specifies whether the menu is created in free-format or in a fixed-format.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>Free-format is not used. A fixed-format menu with two-columns is created. Option text message numbers correspond to the option numbers.
</dd>
<dt><b>*YES</b></dt>
<dd>A free-format menu is created. If *YES is specified, a value must be specified on the <b>Option text message file (OPTTXTMSGF)</b> parameter. Option text message numbers correspond to the row numbers on the display.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.DDSLIST"></a>
<h3>DDS listing (DDSLIST)</h3>
<p>Specifies whether a partial or full DDS compile listing is provided.
</p>
<dl>
<dt><b><u>*PARTIAL</u></b></dt>
<dd>A partial listing is provided.
</dd>
<dt><b>*FULL</b></dt>
<dd>A full DDS listing and cross-reference are provided.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.MAXDEV"></a>
<h3>Maximum devices (MAXDEV)</h3>
<p>Specifies the maximum number of devices that can use the menu at one time.
</p>
<dl>
<dt><b><u>5</u></b></dt>
<dd>The maximum number of devices is five.
</dd>
<dt><b><i>number-of-devices</i></b></dt>
<dd>Specify the maximum number of devices that can use the menu at one time. Valid values range from 1 through 256.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.AUT"></a>
<h3>Authority (AUT)</h3>
<p>Specifies the authority you are giving the users who do not have specific authority to the object, who are not on the authorization list, and whose user group has no specific authority to the object.
</p>
<p>If OPTION(*CREATE) and REPLACE(*YES) are specified, and the display file already exists, the AUT parameter is ignored and the authorities for the old display file are copied to the new display file that replaces it.
</p>
<dl>
<dt><b><u>*LIBCRTAUT</u></b></dt>
<dd>The authority for the object is the same as the value specified on the <b>Create authority (CRTAUT)</b> parameter of the library in which the object is being created. If the value specified on the CRTAUT parameter is changed, the new value will not affect any existing objects.
</dd>
</dl>
<dl>
<dt><b>*USE</b></dt>
<dd>The user can perform basic operations on the object, such as running a program or reading a file. The user cannot change the object. Use (*USE) authority provides object operational (*OBJOPR), read (*READ), and execute (*EXECUTE) authorities.
</dd>
</dl>
<dl>
</dl>
<dl>
<dt><b>*ALL</b></dt>
<dd>The user can perform all operations except those limited to the owner or controlled by authorization list management (*AUTLMGT) authority. The user can control the object's existence, specify the security for the object, change the object, and perform basic functions on the object. The user also can change ownership of the object.
</dd>
</dl>
<dl>
</dl>
<dl>
<dt><b>*CHANGE</b></dt>
<dd>The user can perform all operations on the object except those limited to the owner or controlled by object existence (*OBJEXIST) and object management (*OBJMGT) authorities. The user can change and perform basic functions on the object. *CHANGE authority provides object operational (*OBJOPR) authority and all data authority. If the object is an authorization list, the user cannot add, change, or remove users.
</dd>
</dl>
<dl>
</dl>
<dl>
<dt><b>*EXCLUDE</b></dt>
<dd>The user cannot access the object.
</dd>
</dl>
<dl>
<dt><b><i>authorization-list-name</i></b></dt>
<dd>Specify the name of an authorization list to be used for authority to the object. Users included in the authorization list are granted authority to the object as specified in the list. The authorization list must exist when the object is created.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.TOFILE"></a>
<h3>To DDS source file (TOFILE)</h3>
<p>Specifies the name and library of the source file in which to store the DDS source that is used to create the menu display. The source file need not already exist. If the user is authorized to the CRTSRCPF (Create Source Physical File) command, and the file does not exist, a new source file is created. This parameter is ignored if TOMBR(*NONE) is specified.
</p>
<dl>
<dt><b><u>QDDSSRC</u></b></dt>
<dd>The source file, QDDSSRC, is used.
</dd>
<dt><b><i>file-name</i></b></dt>
<dd>Specify the name of the source file in which to store the DDS source.
<p>The possible library values are:
</p>
<dl>
<dt><b><u>*CMDLIB</u></b></dt>
<dd>The library specified on the Menu## command message file (CMDTXTMSGF) parameter is used to locate the source file.
</dd>
<dt><b>*CURLIB</b></dt>
<dd>The current library for the job is used to locate the file. If no current library entry exists in the library list, the QGPL library is used.
</dd>
<dt><b><i>library-name</i></b></dt>
<dd>Specify the name of the library where the source file is located.
</dd>
</dl>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.TOMBR"></a>
<h3>To DDS source member (TOMBR)</h3>
<p>Specifies the source file member name in which to store the DDS source. If the member does not exist, it is created. When the member name is the same as that of the display file name, and the to-file is QS36DDSSRC in the same library as the display file being created, the DDS is saved in this member only if the compile operation of the display file is successful. To guarantee that the DDS is saved, specify the name of some other source file, library, or member.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>The DDS source is not stored in the source file specified on the <b>To DDS source file (TOFILE)</b> parameter.
</dd>
<dt><b><i>member-name</i></b></dt>
<dd>Specify the name of the source file member in which to store the DDS source. If the member does not exist, it is added. If it exists, it is replaced.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.IGCDTA"></a>
<h3>User specified DBCS data (IGCDTA)</h3>
<p>Specifies whether the display file contains double-byte character data.
</p>
<dl>
<dt><b><u>*NO</u></b></dt>
<dd>The display file does not contain double-byte character data. Option text message IDs must begin with USR.
</dd>
<dt><b>*YES</b></dt>
<dd>The display file or the message files contain double-byte character data. Option text message IDs can begin with USZ.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="CRTMSGFMNU.TGTRLS"></a>
<h3>Target Release (TGTRLS)</h3>
<p>Specifies the release level of the operating system on which you intend to use the object being saved.
</p>
<p>When specifying the <b>target-release</b> value, the format VxRxMx is used to specify the release, where Vx is the version, Rx is the release, and Mx is the modification level. For example, V5R3M0 is version 5, release 3, modification 0.
</p>
<p>Valid values depend on the current version, release, and modification level of the operating system, and they change with each new release. You can press F4 while prompting this command parameter to see a list of valid target release values.
</p>
<dl>
<dt><b><u>*CURRENT</u></b></dt>
<dd>The object is to be restored to, and used on, the release of the operating system currently running on your system. The object can also be restored to a system with any subsequent release of the operating system installed.
</dd>
<dt><b>*PRV</b></dt>
<dd>The object is to be restored to the previous release with modification level 0 of the operating system. The object can also be restored to a system with any subsequent release of the operating system installed.
</dd>
<dt><b><i>character-value</i></b></dt>
<dd>Specify the release in the format VxRxMx. The object can be restored to a system with the specified release or with any subsequent release of the operating system installed.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CRTMSGFMNU.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
CRTMSGFMNU CMDTXTMSGF(MYMENU##) REPLACE(*YES) FREEFORM(*NO)
</pre>
</p>
<p>This command creates a menu by using a message file named MYMENU. The message file is located in the current library for the job and it contains the commands run for each menu option. Because no OPTTXTMSGF parameter is specified, the text of the command appears on the screen in place of the option text. REPLACE(*YES) specifies that an existing display file is replaced. The created display file is in a fixed-format, with options 1 through 24 arranged in two 12-element columns.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CRTMSGFMNU.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>SSP4464</b></dt>
<dd>Member &amp;3 in file &amp;1 in use, cannot be shared.
</dd>
<dt><b>SSP5004</b></dt>
<dd>&amp;1--This load member exists, but is not a $SFGR member.
</dd>
<dt><b>SSP5005</b></dt>
<dd>&amp;1 display file already exists.
</dd>
<dt><b>SSP5011</b></dt>
<dd>&amp;1 not allowed for display file name.
</dd>
<dt><b>SSP5017</b></dt>
<dd>TOFILE library &amp;1 not found.
</dd>
<dt><b>SSP5019</b></dt>
<dd>Terminating errors in $SFGR input specifications.
</dd>
<dt><b>SSP5027</b></dt>
<dd>TGTRLS(*PRV) allowed with changes only when existing display file created for previous release.
</dd>
<dt><b>SSP5451</b></dt>
<dd>Existing file &amp;1 is not a display file.
</dd>
<dt><b>SSP5750</b></dt>
<dd>Command message file messages 1-24 contain only blank text.
</dd>
<dt><b>SSP5751</b></dt>
<dd>Command text message file name must end with ##.
</dd>
<dt><b>SSP5752</b></dt>
<dd>Command text message file library &amp;1 not found.
</dd>
<dt><b>SSP5753</b></dt>
<dd>Command text message file &amp;1 not found.
</dd>
<dt><b>SSP5754</b></dt>
<dd>Option text message file &amp;1 not found.
</dd>
<dt><b>SSP5755</b></dt>
<dd>Unable to create $BMENU work file.
</dd>
<dt><b>SSP5756</b></dt>
<dd>Command message file name must be longer than 2 characters.
</dd>
<dt><b>SSP5757</b></dt>
<dd>Command text message file has no MIC in 0001-0024 range
</dd>
<dt><b>SSP5762</b></dt>
<dd>Option text message file name cannot be same as menu name.
</dd>
<dt><b>SSP5770</b></dt>
<dd>Option text message file required for free format menu.
</dd>
<dt><b>SSP5774</b></dt>
<dd>Command and option message files must not be the same.
</dd>
<dt><b>SSP6124</b></dt>
<dd>Unexpected error occurred.
</dd>
<dt><b>SSP7375</b></dt>
<dd>Error &amp;1 received by &amp;2 utility.
</dd>
<dt><b>SSP8663</b></dt>
<dd>User not authorized to access &amp;1.
</dd>
<dt><b>SSP8679</b></dt>
<dd>Not authorized to access member &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CRTMSGFMNU.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>