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

100 lines
4.4 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>Command Definition (CMD)</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="CMD.Top_Of_Page"></a>
<h2>Command Definition (CMD)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"></td>
<td valign="top" align="right">
<a href="#CMD.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CMD.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CMD.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CMD"></a>
<p>The Command (CMD) command definition statement specifies the prompt text for the command being created. The prompt text is displayed when a user requests prompting while entering the command that is being defined. The CMD statement can be anywhere in the source file referred to by the Create Command (CRTCMD) command; one and only one CMD statement must be used in the source file even if no prompt text is specified for the created command.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CMD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CMD.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"><a href="#CMD.PROMPT"><b>PROMPT</b></a></td>
<td valign="top">Prompt text or message ID</td>
<td valign="top"><i>Character value</i>, <b><u>*NONE</u></b></td>
<td valign="top">Optional, Positional 1</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CMD.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CMD.PROMPT"></a>
<h3>Prompt text or message ID (PROMPT)</h3>
<p>Specifies the prompt text, if any, that is included in the heading (title) of the prompt display for the command being defined. The prompt text further describes the name of the command.
</p>
<p>
<b>Note: </b>Prompt text for each of the parameters of this command can be specified in the PROMPT parameters of the PARM, ELEM, and QUAL command definition statements, which specify the prompt text for the parameters, elements, and qualifiers, just as the PROMPT parameter in this statement specifies the prompt text for the command.
</p>
<dl>
<dt><b><u>*NONE</u></b></dt>
<dd>No prompt text is included in the displayed heading of the prompt when the command is being prompted.
</dd>
<dt><b><i>message-identifier</i></b></dt>
<dd>Specify the message identifier that specifies the message, containing no more than 30 characters, for the prompt text displayed when the command is being prompted. If a message having the specified identifier cannot be found in the message file specified on the PMTFILE parameter of the Create Command (CRTCMD) command, the message identifier itself is used as the prompt text.
</dd>
<dt><b><i>'prompt-text'</i></b></dt>
<dd>Specify the prompt text that is displayed during the command prompting. It must be a character string of no more than 30 characters, enclosed in apostrophes.
<p>Variables cannot be coded for this parameter.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CMD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CMD.COMMAND.EXAMPLES">Examples</a> </h3>
<p>
<pre>
CMD PROMPT(UCD0001)
</pre>
</p>
<p>This statement describes a command that is prompted with additional text in the display heading. The command prompt text comes from the message identified by UCD0001. The message file which contains message identifier UCD0001 must be specified on the PMTFILE parameter of the Create Command (CRTCMD) command used to create the command definition object.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CMD.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CMD.ERROR.MESSAGES">Error messages</a> </h3>
<p>None
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CMD.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>