223 lines
11 KiB
HTML
223 lines
11 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 format" />
|
||
|
|
<meta name="abstract" content="The path name format is common across application programming interfaces that work with objects that are supported across file systems. These APIs require a path name to identify the object with which the API will work." />
|
||
|
|
<meta name="description" content="The path name format is common across application programming interfaces that work with objects that are supported across file systems. These APIs require a path name to identify the object with which the API will work." />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="concept.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../ifs/rzaaxkickoff.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="pns" />
|
||
|
|
<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 format</title>
|
||
|
|
</head>
|
||
|
|
<body id="pns"><a name="pns"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">Path name format</h1>
|
||
|
|
<div><p>The path name format is common across application programming interfaces
|
||
|
|
that work with objects that are supported across file systems. These APIs
|
||
|
|
require a path name to identify the object with which the API will work.</p>
|
||
|
|
<div class="section"><p>The format of the path name is as follows. For a detailed description
|
||
|
|
of each field, see <a href="#pns__HDRPTHDSC">Field descriptions</a>.</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e30">Offset</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e32">Use</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e34">Type</th>
|
||
|
|
<th rowspan="2" valign="top" id="d0e36">Field</th>
|
||
|
|
</tr>
|
||
|
|
<tr><th valign="top" id="d0e39">Dec</th>
|
||
|
|
<th valign="top" id="d0e41">Hex</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e30 d0e39 ">0</td>
|
||
|
|
<td valign="top" headers="d0e30 d0e41 ">0</td>
|
||
|
|
<td valign="top" headers="d0e32 ">INPUT</td>
|
||
|
|
<td valign="top" headers="d0e34 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e36 ">CCSID</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e30 d0e39 ">4</td>
|
||
|
|
<td valign="top" headers="d0e30 d0e41 ">4</td>
|
||
|
|
<td valign="top" headers="d0e32 ">INPUT</td>
|
||
|
|
<td valign="top" headers="d0e34 ">CHAR(2)</td>
|
||
|
|
<td valign="top" headers="d0e36 ">Country or region ID</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e30 d0e39 ">6</td>
|
||
|
|
<td valign="top" headers="d0e30 d0e41 ">6</td>
|
||
|
|
<td valign="top" headers="d0e32 ">INPUT</td>
|
||
|
|
<td valign="top" headers="d0e34 ">CHAR(3)</td>
|
||
|
|
<td valign="top" headers="d0e36 ">Language ID</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e30 d0e39 ">9</td>
|
||
|
|
<td valign="top" headers="d0e30 d0e41 ">9</td>
|
||
|
|
<td valign="top" headers="d0e32 ">INPUT</td>
|
||
|
|
<td valign="top" headers="d0e34 ">CHAR(3)</td>
|
||
|
|
<td valign="top" headers="d0e36 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e30 d0e39 ">12</td>
|
||
|
|
<td valign="top" headers="d0e30 d0e41 ">C</td>
|
||
|
|
<td valign="top" headers="d0e32 ">INPUT</td>
|
||
|
|
<td valign="top" headers="d0e34 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e36 ">Path type indicator</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e30 d0e39 ">16</td>
|
||
|
|
<td valign="top" headers="d0e30 d0e41 ">10</td>
|
||
|
|
<td valign="top" headers="d0e32 ">INPUT</td>
|
||
|
|
<td valign="top" headers="d0e34 ">BINARY(4)</td>
|
||
|
|
<td valign="top" headers="d0e36 ">Length of path name</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e30 d0e39 ">20</td>
|
||
|
|
<td valign="top" headers="d0e30 d0e41 ">14</td>
|
||
|
|
<td valign="top" headers="d0e32 ">INPUT</td>
|
||
|
|
<td valign="top" headers="d0e34 ">CHAR(2)</td>
|
||
|
|
<td valign="top" headers="d0e36 ">Path name delimiter character</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e30 d0e39 ">22</td>
|
||
|
|
<td valign="top" headers="d0e30 d0e41 ">16</td>
|
||
|
|
<td valign="top" headers="d0e32 ">INPUT</td>
|
||
|
|
<td valign="top" headers="d0e34 ">CHAR(10)</td>
|
||
|
|
<td valign="top" headers="d0e36 ">Reserved</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e30 d0e39 ">32</td>
|
||
|
|
<td valign="top" headers="d0e30 d0e41 ">26</td>
|
||
|
|
<td valign="top" headers="d0e32 ">INPUT</td>
|
||
|
|
<td valign="top" headers="d0e34 ">CHAR(*)</td>
|
||
|
|
<td valign="top" headers="d0e36 ">Path name</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="section" id="pns__HDRPTHDSC"><a name="pns__HDRPTHDSC"><!-- --></a><h4 class="sectiontitle">Field descriptions</h4><p>This section describes
|
||
|
|
the path name format fields in further detail. Field descriptions are in alphabetical
|
||
|
|
order.</p>
|
||
|
|
<p><span class="uicontrol">CCSID.</span> The CCSID (coded character set
|
||
|
|
ID) the path name is in. The possible values follow:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e158">Value</th>
|
||
|
|
<th valign="bottom" id="d0e160">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e158 "><em>0</em></td>
|
||
|
|
<td valign="top" headers="d0e160 ">Use the current job default CCSID.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e158 "><em>1-65533</em></td>
|
||
|
|
<td valign="top" headers="d0e160 ">A valid CCSID in this range.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">Country or region ID.</span> The country or region
|
||
|
|
ID for the path name. The possible values follow:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e185">Value</th>
|
||
|
|
<th valign="bottom" id="d0e187">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e185 "><em>X'0000'</em></td>
|
||
|
|
<td valign="top" headers="d0e187 ">Use the current job country or region ID.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e185 "><em>Country or region ID</em></td>
|
||
|
|
<td valign="top" headers="d0e187 ">A valid country or region ID.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">Language ID.</span> The language ID for the path
|
||
|
|
name. The possible values follow:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e212">Value</th>
|
||
|
|
<th valign="bottom" id="d0e214">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e212 "><em>X'000000'</em></td>
|
||
|
|
<td valign="top" headers="d0e214 ">Use the current job language ID.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e212 "><em>Language ID</em></td>
|
||
|
|
<td valign="top" headers="d0e214 ">A valid language ID.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">Length of path name.</span> The length of the
|
||
|
|
path name in bytes.</p>
|
||
|
|
<p><span class="uicontrol">Path name.</span> Depending on
|
||
|
|
the path type indicator field, this field contains either a pointer to a character
|
||
|
|
string that contains the path name, or a character string that contains the
|
||
|
|
path name.</p>
|
||
|
|
<p>The path name must be an absolute path name or a relative
|
||
|
|
path name. An absolute path name is a path name that starts with the path
|
||
|
|
name delimiter, usually the slash (/) character. A relative path name is a
|
||
|
|
path name that does not start with the path name delimiter. When a relative
|
||
|
|
name is specified, the API assumes that this path name starts at the current
|
||
|
|
directory of the process that the API is running in.</p>
|
||
|
|
<p>The dot and dot
|
||
|
|
dot (. ..) directories are valid in the path name. The home directory, generally
|
||
|
|
represented by using the tilde character in the first character position of
|
||
|
|
the path name, is not supported.</p>
|
||
|
|
<p> 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. </p>
|
||
|
|
<p>To avoid confusion with iSeries™ server
|
||
|
|
special values, path names should not start with a single asterisk (*) character.</p>
|
||
|
|
<p><span class="uicontrol">Path
|
||
|
|
name delimiter character.</span> The delimiter character used between
|
||
|
|
the element names in the path name. This is in the same CCSID as the path
|
||
|
|
name. The most common delimiter is the slash (/) character. If the delimiter
|
||
|
|
is 1 character, the first character of the 2-character field is used.</p>
|
||
|
|
<p><span class="uicontrol">Path
|
||
|
|
type indicator.</span> Whether the path name contains a pointer or is
|
||
|
|
a character string and whether the path name delimiter character is 1 or 2
|
||
|
|
characters long. The possible values follow:</p>
|
||
|
|
|
||
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr valign="bottom"><th valign="bottom" id="d0e262">Value</th>
|
||
|
|
<th valign="bottom" id="d0e264">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody><tr><td valign="top" headers="d0e262 "><em>0</em></td>
|
||
|
|
<td valign="top" headers="d0e264 ">The path name is a character string, and the path name delimiter character
|
||
|
|
is 1 character long.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e262 "><em>1</em></td>
|
||
|
|
<td valign="top" headers="d0e264 ">The path name is a pointer, and the path name delimiter character is
|
||
|
|
1 character long.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e262 "><em>2</em></td>
|
||
|
|
<td valign="top" headers="d0e264 ">The path name is a character string, and the path name delimiter character
|
||
|
|
is 2 characters long.</td>
|
||
|
|
</tr>
|
||
|
|
<tr><td valign="top" headers="d0e262 "><em>3</em></td>
|
||
|
|
<td valign="top" headers="d0e264 ">The path name is a pointer, and the path name delimiter character is
|
||
|
|
2 characters long.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<p><span class="uicontrol">Reserved.</span> A reserved field that must be
|
||
|
|
set to hexadecimal zeros.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="concept.htm" title="Describes the underlying concepts that you need to understand to work effectively with APIs. Among the concepts covered are basic concepts, programming considerations, and terminology.">API concepts</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="relinfo"><strong>Related information</strong><br />
|
||
|
|
<div><a href="../ifs/rzaaxkickoff.htm">Integrated File System</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|