Legacy Document

Inside Macintosh: More Macintosh Toolbox /

Chapter 9 - Desktop Manager / Desktop Manager Reference

Routines / Manipulating the Desktop Database Itself

PBDTDelete

The PBDTDelete function removes the desktop database. Unless you are manipulating the desktop database in the absence of the Finder, you should never use this function.

FUNCTION PBDTDelete (paramBlock: DTPBPtr; async: Boolean): OSErr;

paramBlock

A pointer to a desktop parameter block.

async

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

-->	ioCompletion	ProcPtr	A pointer to a completion routine.
\xAE	ioResult	OSErr	The result code of the function.
-->	ioVRefNum	Integer	The volume reference number of the desktop database.
-->	ioIndex	Integer	Reserved; must be set to 0.

DESCRIPTION

The PBDTDelete function removes the desktop database from a local volume. You specify the volume by passing a volume reference number in ioVRefNum. You can call PBDTDelete only when the database is closed.

IMPORTANT

Your application should never call PBDTDelete.

RESULT CODES

noErr	0	No error
ioErr	-36	I/O error
wPrErr	-44	Volume is locked through hardware
vLckdErr	-46	Volume is locked through software
rfNumErr	-51	Reference number invalid
extFSErr	-58	External file system--file system identifier is nonzero