Legacy Document

Inside Macintosh: More Macintosh Toolbox /

Chapter 9 - Desktop Manager / Desktop Manager Reference

Routines / Reading the Desktop Database

PBDTGetComment

To retrieve the user comments for a file or directory, use the PBDTGetComment function.

FUNCTION PBDTGetComment (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.
-->	ioNamePtr	StringPtr	A pointer to a file or directory name.
-->	ioDTRefNum	Integer	The desktop database reference number.
-->	ioDTBuffer	Ptr	A pointer to comment text (200 bytes).
\xAE	ioDTActCount	LongInt	The comment size.
-->	ioDirID	LongInt	The parent directory of the file or directory.

DESCRIPTION

The PBDTGetComment function retrieves the comment stored for a file or directory in the database specified in ioDTRefNum. You specify the filename or directory name and its parent directory ID through ioNamePtr and ioDirID. You allocate a buffer big enough to hold the largest comment, 200 bytes, and put a pointer to it in the ioDTBuffer field. The PBDTGetComment function places the comment in the buffer as a plain text string and places the length of the comment in ioDTActCount.

RESULT CODES

noErr	0	No error
ioErr	-36	I/O error
fnfErr	-43	File or directory doesn't exist
rfNumErr	-51	Reference number invalid
extFSErr	-58	External file system--file system identifier is nonzero
afpItemNotFound	-5012	Information not found