Legacy Document

Inside Macintosh: More Macintosh Toolbox /

Chapter 9 - Desktop Manager / Desktop Manager Reference

Routines / Locating, Opening, and Closing the Desktop Database

PBDTOpenInform

The PBDTOpenInform function performs the same function as PBDTGetPath, but it also reports whether the desktop database was empty when it was opened.

FUNCTION PBDTOpenInform (paramBlock: DTPBPtr): OSErr;

paramBlock

A pointer to a desktop parameter block.

\xAE	ioResult	OSErr	The result code of the function.
-->	ioNamePtr	StringPtr	A pointer to the volume name or full pathname of the desktop database.
-->	ioVRefNum	Integer	The volume reference number of the desktop database.
\xAE	ioDTRefNum	Integer	The desktop database reference number.
\xAE	ioTagInfo	LongInt	The return flag (in low bit).

DESCRIPTION

If the desktop database was just created in response to PBDTOpenInform (and is therefore empty), PBDTOpenInform sets the low bit in the ioTagInfo field to 0. If the desktop database had been created before you called PBDTOpenInform, PBDTOpenInform sets the low bit in the ioTagInfo field to 1.

RESULT CODES

noErr	0	No error
ioErr	-36	I/O error
paramErr	-50	Parameter error; use PBDTGetPath
extFSErr	-58	External file system--file system identifier is nonzero
desktopDamagedErr	-1305	The desktop database has become corrupted--the Finder will fix this, but if your application is not running with the Finder, use PBDTReset or PBDTDelete