Legacy Documentclose button

Important: The information in this document is obsolete and should not be used for new development.

Previous Book Contents Book Index Next

Inside Macintosh: More Macintosh Toolbox /
Chapter 9 - Desktop Manager / Desktop Manager Reference
Routines / Manipulating the Desktop Database Itself


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;
A pointer to a desktop parameter block.
A Boolean value that specifies asynchronous (TRUE) or synchronous (FALSE) execution.
--> ioCompletionProcPtrA pointer to a completion routine.
\xAE ioResultOSErrThe result code of the function.
-->ioDTRefNumIntegerThe desktop database reference number.
--> ioIndexIntegerReserved; must be set to 0.

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.

Your application should never call PBDTReset.
noErr0No error
ioErr-36I/O error
wPrErr-44Volume is locked through hardware
vLckdErr-46Volume is locked through software
rfNumErr-51Reference number invalid
extFSErr-58External file system--file system identifier is nonzero

Previous Book Contents Book Index Next

© Apple Computer, Inc.
6 JUL 1996