Check Out Object (CHKOUT)

Where allowed to run: All environments (*ALL)
Threadsafe: No 		Parameters
Examples
Error messages

The Check Out Object (CHKOUT) command checks out an object. A user profile is used to determine who is checking out the object.

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).

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.

Restrictions:

  1. Only documents within QDLS, and byte stream files can be checked out.
  2. 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.
  3. Not all file systems will support the CHKOUT command.
Top

Parameters

Keyword Description Choices Notes
OBJ Object Path name Required, Positional 1
Top

Object (OBJ)

Specifies the name of the object to check out or a pattern for multiple objects.

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.

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.

Top

Examples

Example 1: Checking an Object Out 

CHKOUT   OBJ('MYDIR/FILE1')

This command checks out FILE1 in the directory, MYDIR, to the job's user profile owner.

Top

Error messages

*ESCAPE Messages

CPFA09C
Not authorized to object. Object is &1.
CPFA09D
Error occurred in program &1.
CPFA09E
Object in use. Object is &1.
CPFA0A1
An input or output error occurred.
CPFA0A3
Path name resolution causes looping.
CPFA0A7
Path name too long.
CPFA0A9
Object not found. Object is &1.
CPFA0AB
Operation failed for object. Object is &1.
CPFA0AD
Function not supported by file system.
CPFA0B2
No objects satisfy request.
CPFA0BE
&1 objects checked in. &2 objects failed.
CPFA0BF
&1 objects checked out. &2 objects failed.
CPFA0DA
Object is a directory. Object is &1.
CPFA1C5
Object is a read only object. Object is &1.
Top