ibm-information-center/dist/eclipse/plugins/i5OS.ic.rbam6_5.4.0.1/rbam6comdefstate.htm

165 lines
11 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?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="Command definition statements" />
<meta name="abstract" content="Command definition allows system users to create additional commands to meet specific application needs." />
<meta name="description" content="Command definition allows system users to create additional commands to meet specific application needs." />
<meta name="DC.subject" content="command definition, statement, description, definition statement, command, command definition, CPP (command processing program), definition, command processing program (CPP), command, CL, processing program (CPP), usage" />
<meta name="keywords" content="command definition, statement, description, definition statement, command, command definition, CPP (command processing program), definition, command processing program (CPP), command, CL, processing program (CPP), usage" />
<meta name="DC.Relation" scheme="URI" content="defcm.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6createuserdefinedcommands.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6delimeters.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6simpqual.htm" />
<meta name="DC.Relation" scheme="URI" content="../ifs/rzaaxkickoff.htm" />
<meta name="DC.Relation" scheme="URI" content="pmtc.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6gencodrulessum.htm" />
<meta name="DC.Relation" scheme="URI" content="intcd.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6nameincom.htm" />
<meta name="DC.Relation" scheme="URI" content="comdefobj.htm" />
<meta name="DC.Relation" scheme="URI" content="doccmd.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rbam6comdefstate" />
<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>Command definition statements</title>
</head>
<body id="rbam6comdefstate"><a name="rbam6comdefstate"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Command definition statements</h1>
<div><p>Command definition allows system users to create additional commands
to meet specific application needs. </p>
<div class="section"><p>These commands are similar to the system commands. The defined
command calls a program to perform some function. Users can define commands
by using command definition statements. The defined command can include the
following:</p>
<ul><li>Keyword notation parameters for passing data to programs</li>
<li>Default values for omitted parameters</li>
<li>Parameter validity checking so the program performing the function will
have correct input</li>
<li>Prompt text for prompting interactive users</li>
</ul>
<p>Each command on the system has a Command definition object and a command
processing program (CPP). </p>
<p>The <strong>CPP</strong> is the program called when
the command is entered. Because the system performs validity checking when
the command is entered, the CPP does not always have to check the parameters
passed to it.</p>
<p>The command definition functions can be used to: </p>
<ul><li>Create unique commands needed by system users while keeping a consistent
interface for CL command users.</li>
<li>Define alternative versions of CL commands to meet the requirements of
system users. This function might include having different defaults for parameter
values, or simplifying the commands so that some parameters would not need
to be entered. Constant values can be defined for those parameters. The
IBM-supplied commands should not be changed.</li>
</ul>
<div class="tablenoborder"><a name="rbam6comdefstate__cmddef"><!-- --></a><table cellpadding="4" cellspacing="0" summary="" id="rbam6comdefstate__cmddef" width="100%" frame="hsides" border="1" rules="all"><caption>Table 1. Statements
for Defining CL Commands</caption><thead align="left"><tr><th align="left" valign="bottom" width="12.82051282051282%" id="d0e88">Statement Type</th>
<th align="left" valign="bottom" width="12.82051282051282%" id="d0e90">Statement Name</th>
<th valign="top" width="26.855600539811064%" id="d0e92">Related command</th>
<th align="left" valign="bottom" width="47.50337381916329%" id="d0e94">Description</th>
</tr>
</thead>
<tbody><tr><td align="left" valign="top" width="12.82051282051282%" headers="d0e88 ">Command</td>
<td align="left" valign="top" width="12.82051282051282%" headers="d0e90 ">CMD</td>
<td valign="top" width="26.855600539811064%" headers="d0e92 "><a href="../cl/cmd.htm">Command
Definition (CMD) command</a></td>
<td align="left" valign="top" width="47.50337381916329%" headers="d0e94 ">Specifies the prompt text for the command
being created. 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.</td>
</tr>
<tr><td align="left" valign="top" width="12.82051282051282%" headers="d0e88 ">Parameter</td>
<td align="left" valign="top" width="12.82051282051282%" headers="d0e90 ">PARM</td>
<td valign="top" width="26.855600539811064%" headers="d0e92 "><a href="../cl/parm.htm">Parameter
Definition (PARM) command</a></td>
<td align="left" valign="top" width="47.50337381916329%" headers="d0e94 ">Defines a parameter of a command being created.
A parameter is the means by which a value is passed to the command processing
program (CPP). One PARM statement must be used for each parameter that appears
in the command being defined.</td>
</tr>
<tr><td align="left" valign="top" width="12.82051282051282%" headers="d0e88 ">Element</td>
<td align="left" valign="top" width="12.82051282051282%" headers="d0e90 ">ELEM</td>
<td valign="top" width="26.855600539811064%" headers="d0e92 "><a href="../cl/elem.htm">Element
Definition (ELEM) command</a></td>
<td align="left" valign="top" width="47.50337381916329%" headers="d0e94 ">Used to define the elements of a mixed list
(list elements) parameter on a command. A list parameter is a parameter that
accepts multiple values that are passed together as consecutive values pointed
to by a single keyword.</td>
</tr>
<tr><td align="left" valign="top" width="12.82051282051282%" headers="d0e88 ">Qualifier</td>
<td align="left" valign="top" width="12.82051282051282%" headers="d0e90 ">QUAL</td>
<td valign="top" width="26.855600539811064%" headers="d0e92 "><a href="../cl/qual.htm">Qualifier
Definition (QUAL) command</a></td>
<td align="left" valign="top" width="47.50337381916329%" headers="d0e94 ">Describes one part of a qualified name.
If a name is the allowed value of a parameter or list element defined in a
PARM or ELEM statement, it can be changed to a qualified name by using a QUAL
statement for each qualifier used to qualify the name.</td>
</tr>
<tr><td align="left" valign="top" width="12.82051282051282%" headers="d0e88 ">Dependency</td>
<td align="left" valign="top" width="12.82051282051282%" headers="d0e90 ">DEP</td>
<td valign="top" width="26.855600539811064%" headers="d0e92 "><a href="../cl/dep.htm">Dependent
Definition (DEP) command</a></td>
<td align="left" valign="top" width="47.50337381916329%" headers="d0e94 ">Defines a required relationship between parameters
and parameter values that must be checked. This relationship can refer to
either the specific value of a parameter or parameters or to the required
presence of parameters.</td>
</tr>
<tr><td align="left" valign="top" width="12.82051282051282%" headers="d0e88 ">Prompt Control</td>
<td align="left" valign="top" width="12.82051282051282%" headers="d0e90 ">PMTCTL</td>
<td valign="top" width="26.855600539811064%" headers="d0e92 "><a href="../cl/pmtctl.htm">Prompt
Control Definition (PMTCTL) command</a></td>
<td align="left" valign="top" width="47.50337381916329%" headers="d0e94 ">Specifies a condition that is tested to determine
if prompting is done for the parameters whose PARM statement refers to the
PMTCTL statement.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="rbam6createuserdefinedcommands.htm">Create user-defined commands</a></strong><br />
Users can define a command by entering command definition statements
into a source file and running a <span class="cmdname">Create Command (CRTCMD)</span> command
using the source file as input. </li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="defcm.htm" title="This describes how you can define and create your own commands.">Define commands</a></div>
</div>
<div class="relconcepts"><strong>Related concepts</strong><br />
<div><a href="rbam6delimeters.htm" title="Command delimiters are special characters or spaces that identify the beginning or end of a group of characters in a command.">Command delimiters</a></div>
<div><a href="rbam6simpqual.htm" title="The name of a specific object that is located in a library can be specified as a simple name or as a qualified name.">Simple and qualified object names</a></div>
<div><a href="rbam6gencodrulessum.htm" title="This section contains a summary of general information needed to properly code CL commands.">Command coding rules</a></div>
<div><a href="intcd.htm" title="Command definition allows system users to create additional commands to meet specific application needs. These commands are similar to the system commands.">Command definition parts</a></div>
<div><a href="rbam6nameincom.htm" title="You can use only specific characters for naming within commands.">Naming within commands</a></div>
<div><a href="comdefobj.htm" title="The command definition object is the object that is checked by a system program to ensure that the command is valid and that the correct parameters were entered.">Command definition object</a></div>
</div>
<div class="reltasks"><strong>Related tasks</strong><br />
<div><a href="pmtc.htm" title="You can control which parameters are displayed for a command during prompting by using prompt control specifications.">Use prompt control</a></div>
<div><a href="doccmd.htm" title="You can create online help and HTML command description information for commands that you create.">Document commands</a></div>
</div>
<div class="relinfo"><strong>Related information</strong><br />
<div><a href="../ifs/rzaaxkickoff.htm">Integrated file systems</a></div>
</div>
</div>
</body>
</html>