ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/chkout.htm

150 lines
5.0 KiB
HTML

<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Check Out Object (CHKOUT)</title>
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body bgcolor="white">
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<a name="CHKOUT.Top_Of_Page"></a>
<h2>Check Out Object (CHKOUT)</h2>
<table width="100%">
<tr>
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
<b>Threadsafe: </b>No
</td>
<td valign="top" align="right">
<a href="#CHKOUT.PARAMETERS.TABLE">Parameters</a><br>
<a href="#CHKOUT.COMMAND.EXAMPLES">Examples</a><br>
<a href="#CHKOUT.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="CHKOUT"></a>
<p>The Check Out Object (CHKOUT) command checks out an object. A user profile is used to determine who is checking out the object.
</p>
<p>When an object is checked out, other users can read and copy the object. Only the user who has the object checked out can change the object until it is checked in (see the Check In Object (CHKIN) command).
</p>
<p>For more information about integrated file system commands, see the Integrated file system information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>Only documents within QDLS, and byte stream files can be checked out.
</li>
<li>The user who submits this command must have write (*W) authority to the object and at least execute (*X) authority to the directory prefixes in the path.
</li>
<li>Not all file systems will support the CHKOUT command.
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHKOUT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="CHKOUT.PARAMETERS.TABLE">Parameters</a></h3>
<table border="1" cellpadding="4" cellspacing="0">
<!-- col1="10" col2="15" col3="30" col4="10" -->
<tr>
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
</tr>
<tr>
<td valign="top"><a href="#CHKOUT.OBJ"><b>OBJ</b></a></td>
<td valign="top">Object</td>
<td valign="top"><i>Path name</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#CHKOUT.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="CHKOUT.OBJ"></a>
<h3>Object (OBJ)</h3>
<p>Specifies the name of the object to check out or a pattern for multiple objects.
</p>
<p>The object path name can be either a simple name or a name that is qualified with the name of the directory in which the object is located. A pattern can be specified in the last part of the path name. An asterisk (*) matches any number of characters and a question mark (?) matches a single character. If the path name is qualified or contains a pattern, it must be enclosed in apostrophes.
</p>
<p>For more information on specifying path names, refer to "Object naming rules" in the CL concepts and reference topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHKOUT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CHKOUT.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Checking an Object Out</b>
</p>
<p>
<pre>
CHKOUT OBJ('MYDIR/FILE1')
</pre>
</p>
<p>This command checks out FILE1 in the directory, MYDIR, to the job's user profile owner.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHKOUT.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="CHKOUT.ERROR.MESSAGES">Error messages</a> </h3>
<p><b><u>*ESCAPE Messages</u></b>
</p>
<dl>
<dt><b>CPFA09C</b></dt>
<dd>Not authorized to object. Object is &amp;1.
</dd>
<dt><b>CPFA09D</b></dt>
<dd>Error occurred in program &amp;1.
</dd>
<dt><b>CPFA09E</b></dt>
<dd>Object in use. Object is &amp;1.
</dd>
<dt><b>CPFA0A1</b></dt>
<dd>An input or output error occurred.
</dd>
<dt><b>CPFA0A3</b></dt>
<dd>Path name resolution causes looping.
</dd>
<dt><b>CPFA0A7</b></dt>
<dd>Path name too long.
</dd>
<dt><b>CPFA0A9</b></dt>
<dd>Object not found. Object is &amp;1.
</dd>
<dt><b>CPFA0AB</b></dt>
<dd>Operation failed for object. Object is &amp;1.
</dd>
<dt><b>CPFA0AD</b></dt>
<dd>Function not supported by file system.
</dd>
<dt><b>CPFA0B2</b></dt>
<dd>No objects satisfy request.
</dd>
<dt><b>CPFA0BE</b></dt>
<dd>&amp;1 objects checked in. &amp;2 objects failed.
</dd>
<dt><b>CPFA0BF</b></dt>
<dd>&amp;1 objects checked out. &amp;2 objects failed.
</dd>
<dt><b>CPFA0DA</b></dt>
<dd>Object is a directory. Object is &amp;1.
</dd>
<dt><b>CPFA1C5</b></dt>
<dd>Object is a read only object. Object is &amp;1.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#CHKOUT.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>