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

153 lines
10 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="concept" />
<meta name="DC.Title" content="Command coding rules" />
<meta name="abstract" content="This section contains a summary of general information needed to properly code CL commands." />
<meta name="description" content="This section contains a summary of general information needed to properly code CL commands." />
<meta name="DC.Relation" scheme="URI" content="rbam6alphalist.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6delimeters.htm" />
<meta name="DC.Relation" scheme="URI" content="intcd.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6comdefstate.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6expand.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6key.htm" />
<meta name="DC.Relation" scheme="URI" content="rbam6parmvalues.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="rbam5gencodrulessum" />
<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 coding rules</title>
</head>
<body id="rbam5gencodrulessum"><a name="rbam5gencodrulessum"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Command coding rules</h1>
<div><p>This section contains a summary of general information needed to
properly code CL commands.</p>
<div class="section"><h4 class="sectiontitle">Delimiters</h4><ul><li>Blanks are the basic separators between the parts of a command: <ul><li>Between command label and command name (not required, because the colon
[:] is the delimiter).</li>
<li>Between command name and first parameter, and between parameters.</li>
<li>Between values in a list of values (not required between ending and beginning
parentheses that enclose nested lists inside a list).</li>
<li>Between the slashes and the name or label of some job control commands,
like // DATA (not required).</li>
</ul>
</li>
<li>Blanks <em>cannot</em> separate a parameter's keyword from the left parenthesis
preceding its values. When a keyword is used, parentheses must be used to
enclose the values; blanks <em>can</em> occur between the parentheses and the
values. For example, KWD(  A  ) is valid.</li>
<li>Multiple blanks are treated as a single blank, unless they occur in a
quoted string or a comment.</li>
<li>A colon must immediately follow a command label. Only one label can be
used on any command (LABEL1: DCLF).</li>
<li>Apostrophes must be used to specify the beginning and end of a quoted
character string. If a character string contains special characters, such
as blanks, apostrophes are required. If an apostrophe must be used in the
quoted string, two apostrophes must be entered consecutively to indicate that
it is an apostrophe and not the end of the quoted string.</li>
<li>Parentheses must be used: <ul><li>On parameters that are specified (coded) in keyword form</li>
<li>To group multiple values in a single list, in a positional parameter,
or around expressions</li>
<li>To indicate a list (of none, one, or several elements) nested inside <em>another</em> list</li>
</ul>
</li>
<li>Sets of parentheses inside parentheses can be entered as long as they
are paired, up to the maximum of five nested levels in logical expressions
or three nested levels in lists of values.</li>
<li>Comments can appear wherever blanks are permitted, except after a continuation
character on the same line or record.</li>
<li>A plus or minus sign at the end of a line indicates that the command is
continued on the following line. Blanks following a + or - sign in the same
record are ignored; blanks in the next record that precede the first non-blank
character are ignored when + is specified and included when - is specified.
One blank must precede the + sign when it is used between separate parameters
or values.</li>
</ul>
</div>
<div class="section"><h4 class="sectiontitle">Parameters</h4><ul><li>All required parameters must be coded.</li>
<li>If an optional parameter is not coded, the system uses its default value
if the parameter has one. A default value is indicated by showing the value
as bold and underlined text in the Choices column of the parameter summary
table. </li>
<li>Words or abbreviations specified in capital letters in the command and
parameter descriptions must be coded as shown. This is true of all command
names, the keywords of parameters (if used), and many parameter values. Lowercase
letters not coded in quoted strings or in comments are translated to uppercase
letters. Lowercase letters specified for values on parameters defined as CASE(*MIXED)
are not translated to uppercase letters.</li>
<li>If there are key parameters, the values for the key parameters must be
entered on the prompt before the remaining parameters will be shown. The
Notes column in the parameter summary table indicates which parameters, if
any, are key parameters. </li>
<li> Parameters cannot be coded in positional form past the positional parameter
limit defined in the command object. The Notes column in the parameter summary
table indicates which parameters may be specified in positional form. </li>
</ul>
</div>
<div class="section"><h4 class="sectiontitle">Parameter Values</h4><ul><li>The first character in all names must be an alphabetic character (A through
Z, $, #, @, or a double quotation mark (")). Names must not exceed 10 characters
(CL variable names and built-in function names can have 11 characters maximum,
including the preceding &amp; or % characters). In some commands, the names
of objects can be specified in qualified form (library-name/object-name) or
in path name form (directory-name/object name).</li>
<li>Predefined values that begin with an asterisk can be used only for the
purposes intended, unless they are included in comments or quoted strings.
These include predefined parameter values (*ALL, for example), symbolic operators
(*EQ, for example), and the null value (*N).</li>
<li>In a CL program, a variable can be specified for all parameters, except
where that is explicitly restricted. The user-specified value of the variable
is passed as if it had been specified on the command.</li>
<li>In a CL program, a character string expression can be specified for any
parameter defined with EXPR(*YES). The resulting value of the expression is
passed as if the value had been specified on the command. </li>
<li>Null (omitted) values are specified with the characters *N, which mean
that no value was specified and the default value, if one exists, should be
used. *N is needed only when another value following the omitted value is
being specified as a positional parameter or an element in a list.</li>
<li>Either a comma or a period can be used to indicate a decimal point in
a numeric value. The decimal point is the only special character allowed between
digits in the numeric string; there is no delimiter for indicating thousands.</li>
<li>When repetition is indicated for a parameter: <ul><li>A predefined value is not coded more than once in a series of values.</li>
<li>As many user-defined values (like names or numeric limits) can be entered
as there are different values or names, up to the maximum number of repetitions
allowed. For example, if a parameter description states "Up to 20 repetitions,"
you can specify a maximum of 20 values. </li>
</ul>
</li>
</ul>
<div class="note"><span class="notetitle">Note:</span> When you are using parameters that have the same name in different
commands, the meaning of (and the values for) that parameter in each command
may be somewhat different. Refer to the correct command description for the
explanation of the parameter you are using.</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rbam6alphalist.htm" title="This defines a command and provides information about how commands are named, the parts of a command, and command documentation. A control language (CL) command is a single control language statement.">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="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>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="rbam6comdefstate.htm" title="Command definition allows system users to create additional commands to meet specific application needs.">Command definition statements</a></div>
<div><a href="rbam6expand.htm" title="This section contains the expanded descriptions of some of the parameters commonly used in the CL commands.">Commonly used parameters</a></div>
<div><a href="rbam6key.htm" title="You can specify parameters in CL using keyword form, positional form, or in a combination of the two.">Parameters in keyword and positional form</a></div>
<div><a href="rbam6parmvalues.htm" title="A parameter value is user-supplied information used during the running of a command.">Parameter values</a></div>
</div>
</div>
</body>
</html>