105 lines
6.9 KiB
HTML
105 lines
6.9 KiB
HTML
<?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 APIs" />
|
|
<meta name="abstract" content="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." />
|
|
<meta name="description" content="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." />
|
|
<meta name="DC.subject" content="integrated file system, programming interfaces, path name rules, path name, rules for APIs, API, path name rules, functions, example, path names" />
|
|
<meta name="keywords" content="integrated file system, programming interfaces, path name rules, path name, rules for APIs, API, path name rules, functions, example, path names" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaaxprogapi.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="rzaaxcmdpath.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qjoejobj.htm" />
|
|
<meta name="DC.Relation" scheme="URI" content="../apis/qjosjobj.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="rzaaxapipath" />
|
|
<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 APIs</title>
|
|
</head>
|
|
<body id="rzaaxapipath"><a name="rzaaxapipath"><!-- --></a>
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
|
<h1 class="topictitle1">Path name rules for APIs</h1>
|
|
<div><p>When using an integrated file system or ILE C/400<sup>®</sup> 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. </p>
|
|
<div class="section"><p>The term <dfn class="term">object</dfn> in these
|
|
rules refers to any directory, file, link, or other object.</p>
|
|
<ul><li>Path names are specified in hierarchical order beginning with the highest
|
|
level of the directory hierarchy. The name of each component in the path is
|
|
separated by a slash (/); for example: <pre> Dir1/Dir2/Dir3/UsrFile</pre>
|
|
<p>The
|
|
backslash (\) is not recognized as a separator. It is handled as just another
|
|
character in a name.</p>
|
|
</li>
|
|
<li>Object names must be unique within a directory.</li>
|
|
<li>The maximum length of each component of the path name and the maximum
|
|
length of the path name string can vary for each file system. </li>
|
|
<li>A / character at the beginning of a path name means that the path begins
|
|
at 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 / character, the path is assumed
|
|
to begin at the current directory; for example: <pre> MyDir/MyFile</pre>
|
|
<p>where
|
|
MyDir is a subdirectory of the current directory.</p>
|
|
</li>
|
|
<li> To avoid confusion with <span class="keyword">iSeries™ server</span> special
|
|
values, path names cannot start with a single asterisk (*) character.
|
|
To specify a path name that begins with any number of characters, use two
|
|
asterisks (*); for example: <pre> '**.file' </pre>
|
|
<p>Note
|
|
that this only applies to relative path names where there are no other characters
|
|
before the asterisk (*).</p>
|
|
</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/PAYROLL.LIB/PAY.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>Do not use a colon (:) in path names. It has a special meaning within
|
|
the server.</li>
|
|
<li>Unlike path names in integrated file system commands ,
|
|
an asterisk (*), a question mark (?), a single quotation mark ('), a quotation
|
|
mark ("), and a tilde (~) have no special significance. They are handled as
|
|
if they are just another character in a name. To avoid confusion with <span class="keyword">iSeries server</span> special values, path names
|
|
should not start with a single asterisk (*) character. The only APIs that
|
|
are exceptions to this rule are <span class="apiname">QjoEndJournal</span> and <span class="apiname">QjoStartJournal</span>.</li>
|
|
<li>When using the Qlg (using NLS-enabled path names) API interfaces, a null
|
|
character value is not allowed as one of the characters in the path name unless
|
|
a null character is specified as a path name delimiter.</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzaaxprogapi.htm" title="Many of the application program interfaces (APIs) that perform operations on integrated file system objects are in the form of C language functions.">Perform operations using APIs</a></div>
|
|
</div>
|
|
<div class="relconcepts"><strong>Related concepts</strong><br />
|
|
<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="rzaaxcmdpath.htm" title="When using an integrated file system command or display to operate on an object, you identify the object by supplying its path name.">Path name rules for CL commands and displays</a></div>
|
|
</div>
|
|
<div class="relinfo"><strong>Related information</strong><br />
|
|
<div><a href="../apis/qjoejobj.htm">QjoEndJournal API</a></div>
|
|
<div><a href="../apis/qjosjobj.htm">QjoStartJournal API</a></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html> |