Legacy Document

Inside Macintosh: Files /

Chapter 2 - File Manager / File Manager Reference

Shared Environment Routines / Copying and Moving Files

PBHMoveRename

You can use the PBHMoveRename function to move a file or directory and optionally to rename it.

FUNCTION PBHMoveRename (paramBlock: HParmBlkPtr; 
                        async: Boolean): OSErr;

paramBlock

A pointer to a copyParam variant of the HFS 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 a pathname.
-->	ioVRefNum	Integer	A volume specification.
-->	ioNewName	Ptr	A pointer to the destination pathname (may be NIL).
-->	ioCopyName	Ptr	A pointer to the file's new name (may be NIL).
-->	ioNewDirID	LongInt	The destination directory ID.
-->	ioDirID	LongInt	The source directory ID.

DESCRIPTION

The PBHMoveRename function allows you to move (not copy) a file or directory and optionally to rename it. The source and destination pathnames must point to the same file server volume.

You specify the source file or directory with the ioVRefNum, ioDirID, and ioNamePtr fields. You specify the destination directory with the ioNewDirID and ioNewName fields. If ioNewName is NIL, the destination directory is the directory having ID ioNewDirID on the specified volume; if ioNewName is not NIL, the destination directory is the directory having the partial pathname pointed to by ioNewName in
the directory having ID ioNewDirID on the specified volume.

The ioCopyName field may contain a pointer to an optional string to be used in copying the file or directory; if it is not NIL, the moved object is renamed to the name specified
in ioCopyName. The string pointed to by ioCopyName must be a filename, not a
partial pathname.

ASSEMBLY-LANGUAGE INFORMATION

The trap macro and routine selector for PBHMoveRename are

Trap macro	Selector
_HFSDispatch	$0037

RESULT CODES

noErr	0	No error
fnfErr	-43	Source file or directory not found
fLckdErr	-45	File is locked
vLckdErr	-46	Destination volume is read-only
dupFNErr	-48	Destination already exists
paramErr	-50	Function not supported by volume
badMovErr	-122	Attempted to move directory into offspring
afpAccessDenied	-5000	The user does not have the right to move the file or directory