Legacy Document

Inside Macintosh: More Macintosh Toolbox /

Chapter 9 - Desktop Manager / Desktop Manager Reference

Routines / Manipulating the Desktop Database Itself

PBDTReset

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

FUNCTION PBDTReset (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.
-->	ioDTRefNum	Integer	The desktop database reference number.
-->	ioIndex	Integer	Reserved; must be set to 0.

DESCRIPTION

The PBDTReset function removes all icons, application mappings, and comments from the desktop database specified in ioDTRefNum. You can call PBDTReset only when the database is open. It remains open after the data is cleared.

IMPORTANT

Your application should never call PBDTReset.

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