Legacy Document

Inside Macintosh: Files /

Chapter 2 - File Manager / File Manager Reference

Low-Level HFS Routines / Moving Files or Directories

PBCatMove

You can use the PBCatMove function to move files or directories from one directory to another on the same volume.

FUNCTION PBCatMove (paramBlock: CMovePBPtr; async: Boolean): 
                     OSErr;

paramBlock

A pointer to a catalog move parameter block.

async

A Boolean value that specifies asynchronous (TRUE) or synchronous (FALSE) execution.

-->	ioCompletion	ProcPtr	A pointer to a completion routine.
<--	ioResult	OSErr	The result code of the function.
-->	ioNamePtr	StringPtr	A pointer to the name of the file or directory to be moved.
-->	ioVRefNum	Integer	A volume specification.
-->	ioNewName	StringPtr	A pointer to the name of the directory into which the file or directory is to be moved.
-->	ioNewDirID	LongInt	The directory ID of the directory into which the file or directory is to be moved, if ioNewName is NIL. If ioNewName is not NIL, this is the parent directory ID of the directory into which the file or directory is to be moved.
-->	ioDirID	LongInt	The directory ID of the file or directory to be moved.

DESCRIPTION

The PBCatMove function moves a file or directory from one directory to another within a volume. PBCatMove is strictly a file catalog operation; it does not actually change the location of the file or directory on the disk.

The source file or directory should be specified by its volume, parent directory ID, and partial pathname. Pass a volume specification in ioVRefNum. Pass the parent directory ID in the ioDirID field and a pointer to the partial pathname in the ioNamePtr field.

The name of the directory into which the file or directory is to be moved is specified by the ioNewName field. If a valid directory name is provided for ioNewName, the destination directory's parent directory is specified in ioNewDirID. However, you can specify NIL for ioNewName, in which case ioNewDirID should be set to the directory ID of the destination directory itself.

Note

It is usually simplest to specify the destination directory by passing
its directory ID in the ioNewDirID field and by setting ioNewName
to NIL.

The PBCatMove function cannot move a file or directory to another volume (that is, ioVRefNum is used in specifying both the source and the destination). Also, you cannot use it to rename files or directories; to rename a file or directory, use PBHRename.

If a file ID reference exists for the file, the file ID reference remains with the moved file.

ASSEMBLY-LANGUAGE INFORMATION

The trap macro and routine selector for PBCatMove are

Trap macro	Selector
_HFSDispatch	$0005

RESULT CODES

noErr	0	No error
nsvErr	-35	No such volume
ioErr	-36	I/O error
bdNamErr	-37	Bad filename or attempt to move into a file
fnfErr	-43	File not found
wPrErr	-44	Hardware volume lock
fLckdErr	-45	Target directory is locked
vLckdErr	-46	Software volume lock
dupFNErr	-48	Duplicate filename and version
paramErr	-50	No default volume
badMovErr	-122	Attempt to move into offspring
wrgVolTypErr	-123	Not an HFS volume
afpAccessDenied	-5000	User does not have the correct access