Legacy Document

Inside Macintosh: More Macintosh Toolbox /

Chapter 9 - Desktop Manager / Desktop Manager Reference

Routines / Manipulating the Desktop Database Itself

PBDTGetInfo

To determine the parent directory and the amount of space used by the desktop database on a particular volume, use the PBDTGetInfo function.

FUNCTION PBDTGetInfo (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.
\xAE	ioVRefNum	Integer	The volume reference number where the database files are actually stored.
-->	ioDTRefNum	Integer	The desktop database reference number.
\xAE	ioIndex	Integer	The number of files comprising the desktop database on the volume.
\xAE	ioDirID	LongInt	The parent directory of the desktop database.
\xAE	ioDTLgLen	LongInt	The logical length of the database files.
\xAE	ioDTPyLen	LongInt	The physical length of the database files.

DESCRIPTION

The PBDTGetInfo function returns information about the desktop database. You specify the volume of the desktop database in ioDTRefNum. The parent directory of the desktop database for the volume is returned in ioDirID. The sum of the logical lengths of the files that constitute the desktop database for a given volume is returned in ioDTLgLen; the sum of the physical lengths of the files that constitute the desktop database for a given volume is returned in ioDTPyLen. The number of files comprising the desktop database is returned in ioIndex.

RESULT CODES

noErr	0	No err
nsvErr	-35	No such volume
ioErr	-36	I/O error
rfNumErr	-51	Reference number invalid
extFSErr	-58	External file system--file system identifier is nonzero