ibm-information-center/dist/eclipse/plugins/i5OS.ic.ifs_5.4.0.1/rzaaxcmdpath.htm

173 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="Path name rules for CL commands and displays" />
<meta name="abstract" content="When using an integrated file system command or display to operate on an object, you identify the object by supplying its path name." />
<meta name="description" content="When using an integrated file system command or display to operate on an object, you identify the object by supplying its path name." />
<meta name="DC.subject" content="integrated file system, commands, path name rules, menus and displays, path name, rules for commands and displays, displays, path name rules, menus, path name rules, example, path names" />
<meta name="keywords" content="integrated file system, commands, path name rules, menus and displays, path name, rules for commands and displays, displays, path name rules, menus, path name rules, example, path names" />
<meta name="DC.Relation" scheme="URI" content="rzaaxifscmd.htm" />
<meta name="DC.Relation" scheme="URI" content="rzaaxfsknow.htm" />
<meta name="DC.Relation" scheme="URI" content="../rbam6/rbam6clmain.htm" />
<meta name="DC.Relation" scheme="URI" content="rzaaxapipath.htm" />
<meta name="DC.Relation" scheme="URI" content="rzaaxpath.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1999, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzaaxcmdpath" />
<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>Path name rules for CL commands and displays</title>
</head>
<body id="rzaaxcmdpath"><a name="rzaaxcmdpath"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Path name rules for CL commands and displays</h1>
<div><p>When using an integrated file system command or display to operate
on an object, you identify the object by supplying its path name.</p>
<div class="section"><p>The following list is a summary of rules
to keep in mind when specifying path names. The term <dfn class="term">object</dfn> in
these rules refers to any directory, file, link, or other object:</p>
<ul><li>Object names must be unique within each directory.</li>
<li>The path name that is passed to an integrated file system CL command must
be represented in the CCSID currently in effect for the job. If the CCSID
of the job is 65535, the path name must be represented in the default CCSID
of the job. Because text strings are normally encoded in CCSID 37, it is necessary
to convert hard-coded path names to the job CCSID before passing the path
to the command.</li>
<li>Path names must be enclosed in single quotation marks (') when entered
on a command line. These marks are optional when path names are entered on
displays. If the path name includes any quoted strings, however, the enclosing
'  ' marks must also be included.</li>
<li>Path names are entered left to right, beginning with
the highest-level directory and ending with the name of the object to be operated
on by the command. The name of each component in the path is separated by
a slash (/).<div class="note"><span class="notetitle">Note:</span> Some
CL commands also allow the backslash (\) to be used as a separator by automatically
converting the backslash (\) to a slash (/). Some other CL commands, however,
treat the backslash (\) no differently than they would any other character.
Therefore, the backslash (\) separator should be used with caution.</div>
<p>For
example:</p>
<pre> 'Dir1/Dir2/Dir3/UsrFile'</pre>
<p>or</p>
<pre> 'Dir1\Dir2\Dir3\UsrFile'</pre>
</li>
<li>The slash (/) and backslash (\) characters and nulls
cannot be used in the individual components of the path name when the slash
(/) and backslash (\) are used as separators. Lowercase letters are not changed
to uppercase letters by the commands. The name might or might not be changed
to uppercase, depending on whether the file system containing the object is
case-sensitive and whether the object is being created or searched for.</li>
<li>The length of an object name is limited by the file system the object
is in and the maximum length of a command string. The commands will accept
object names up to 255 characters long and path names up to 5000 characters
long. </li>
<li>A separator character (for example: /) at the beginning
of a path name means that the path begins at the topmost directory, the <span class="q">"root"</span> (/)
directory; for example: <pre> '/Dir1/Dir2/Dir3/UsrFile'</pre>
</li>
<li>If the path name does not begin with a separator
character (for example: /) , the path is assumed to begin at the current directory
of the user entering the command; for example: <pre> 'MyDir/MyFile'</pre>
<p>where
MyDir is a subdirectory of the user's current directory.</p>
</li>
<li>A tilde (~) character followed by a separator character
(for example: /) at the beginning of a path name means that the path begins
at the home directory of the user entering the command; for example: <pre> '~/UsrDir/UsrObj'</pre>
</li>
<li>A tilde (~) character followed by a user name and
then a separator character (for example: /) at the beginning of a path name
means that the path begins at the home directory of the user identified by
the user name; for example: <pre> '~user-name/UsrDir/UsrObj'</pre>
</li>
<li>In some commands, an asterisk (*) or a question mark (?) can be used in
the last component of a path name to search for patterns of names. The *
tells the system to search for names that have any number of characters in
the position of the * character. The ? tells the system to search for names
that have a single character in the position of the ? character. The following
example searches for all objects whose names begin with <em>d</em> and end with <em>txt</em>:
<pre> '/Dir1/Dir2/Dir3/d*txt'</pre>
<div class="p">The following example
searches for objects whose names begin with <em>d</em> followed by any single
character and end with <em>txt</em>: <pre> '/Dir1/Dir2/Dir3/d?txt'</pre>
</div>
</li>
<li> To avoid confusion with <span class="keyword">iSeries™ server</span> special
values, path names cannot start with a single asterisk (*) character.
To perform a pattern match at the beginning of a path name, use two asterisks
(*); for example: <pre> '**.file' </pre>
<div class="note"><span class="notetitle">Note:</span> This
only applies to relative path names where there are no other characters before
the asterisk (*).</div>
</li>
<li>When operating on objects in the QSYS.LIB file system, the component names
must be of the form <em>name.object-type</em>; for example: <pre> '/QSYS.LIB/PAY.LIB/TAX.FILE' </pre>
</li>
<li>When operating on objects in the independent ASP QSYS.LIB file system,
the component names must be of the form <em>name.object-type</em>; for example:
<pre> '/asp_name/QSYS.LIB/PAYDAVE.LIB/PAY.FILE</pre>
</li>
<li>The path name must be enclosed in additional sets of single quotation
marks (') or quotation marks (") if any of the following characters is used
in a component name: <ul><li>Asterisk (*) <div class="note"><span class="notetitle">Note:</span> To avoid confusion with <span class="keyword">iSeries server</span> special values, path names
should not start with a single asterisk (*) character.</div>
</li>
<li>Question mark (?)</li>
<li>Single quotation mark (')</li>
<li>Quotation mark (")</li>
<li>Tilde (~), if used as the first character in the first component name
of the path name (if used in any other position, the tilde is interpreted
as just another character)</li>
</ul>
<p>For example:</p>
<pre> '<span><span class="q">"/Dir1/Dir/A*Smith"</span></span>'</pre>
<p>or</p>
<pre> '''/Dir1/Dir/A*Smith'''</pre>
This practice is not recommended because the meaning of the character in
a command string can be confused and it is more likely that the command string
will be entered incorrectly.</li>
<li>Do not use a colon (:) in path names. It has a special meaning within
the system.</li>
<li>The processing support for commands and associated
user displays does not recognize code points below hexadecimal 40 as characters
that can be used in command strings or on displays. If these code points are
used, they must be entered as a hexadecimal representation, such as the following
example: <pre> crtdir dir(X'02')</pre>
<p>Therefore, use of
code points below hexadecimal 40 in path names is not recommended. This restriction
applies only to commands and associated displays, not to APIs.
In addition, a value of hexadecimal 0 is not allowed in path names.</p>
</li>
</ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaaxifscmd.htm" title="All of the operations that you can do through the integrated file system menus and displays can be done by entering control language (CL) commands. These commands can operate on files and other objects in any file system that are accessible through the integrated file system interface.">Access using CL commands</a></div>
</div>
<div class="relconcepts"><strong>Related concepts</strong><br />
<div><a href="rzaaxfsknow.htm" title="A file system provides you the support to access specific segments of storage that are organized as logical units. These logical units on your server are files, directories, libraries, and objects.">Work with file systems</a></div>
<div><a href="rzaaxpath.htm" title="A path name (also called a pathname on some systems) tells the server how to locate an object.">Path name</a></div>
</div>
<div class="relref"><strong>Related reference</strong><br />
<div><a href="rzaaxapipath.htm" title="When using an integrated file system or ILE C/400 API to operate on an object, you identify the object by supplying its directory path. Here is a summary of rules to keep in mind when specifying path names in the APIs.">Path name rules for APIs</a></div>
</div>
<div class="relinfo"><strong>Related information</strong><br />
<div><a href="../rbam6/rbam6clmain.htm">Control language (CL)</a></div>
</div>
</div>
</body>
</html>