Legacy Document

Inside Macintosh: Files /

Chapter 2 - File Manager / File Manager Reference

File ID Routines / Creating and Deleting File ID References

PBDeleteFileIDRef

You can use the PBDeleteFileIDRef function to delete a file ID reference.

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

paramBlock

A pointer to an fidParam 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 filename.
-->	ioVRefNum	Integer	A volume specification.
-->	ioFileID	LongInt	A file ID.

DESCRIPTION

The PBDeleteFileIDRef function invalidates the specified file ID reference on the volume specified by ioVRefNum or ioNamePtr. After it has invalidated a file ID
reference, the File Manager can no longer resolve that ID reference to a filename and
parent directory ID.

ASSEMBLY-LANGUAGE INFORMATION

The trap macro and routine selector for PBDeleteFileIDRef are

Trap macro	Selector
_HFSDispatch	$0015

RESULT CODES

noErr	0	No error
nsvErr	-35	Volume not found
ioErr	-36	I/O error
fnfErr	-43	File not found
wPrErr	-44	Hardware volume lock
vLckdErr	-46	Software volume lock
paramErr	-50	Function not supported by volume
volOfflinErr	-53	Volume is offline
extFSErr	-58	External file system
wrgVolTypErr	-123	Function is not supported by volume
fidNotFoundErr	-1300	File ID not found
afpAccessDenied	-5000	User does not have the correct access
afpObjectTypeErr	-5025	Specified file is a directory
afpIDNotFound	-5034	File ID not found