Legacy Document

Inside Macintosh: More Macintosh Toolbox /

Chapter 9 - Desktop Manager / Desktop Manager Reference

Routines / Deleting Entries From the Desktop Database

PBDTRemoveComment

To remove a user comment from the desktop database, call the PBDTRemoveComment function.

FUNCTION PBDTRemoveComment (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 the filename or directory name.
-->	ioDTRefNum	Integer	The desktop database reference number.
-->	ioDirID	LongInt	The parent directory of the file or directory.

DESCRIPTION

The PBDTRemoveComment function removes the comment associated with a file or directory from the database specified in ioDTRefNum. You specify the file or directory name through ioNamePtr and the parent directory ID in ioDirID. You cannot remove a comment if the file or directory is not present on the volume. If no comment was stored for the file, PBDTRemoveComment returns an error.

RESULT CODES

noErr	0	No error
ioErr	-36	I/O error
fnfErr	-43	File or directory doesn't exist
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
afpItemNotFound	-5012	Comment not found