PBDTRemoveCommentSync
PBDTRemoveComment Remove a user comment from the desktop database.
OSErr PBDTRemoveComment(paramBlock, async); DTPBPtr paramBlock ; pointer to a DTPB Param Block
Boolean async; 0 = await completion; 1 = immediate return Parameter block
ۮ 12 ioCompletion long completion routine
۬ 16 ioResult short result code
ۮ 18 ioNamePtr long pointer to filename or directory name
ۮ 24 ioDTRefNum short database reference number
ۮ 48 ioDirID long parent directory of file or directory
PBDTRemoveComment 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.
Returns: an Error code. It will be one of the following:
noErr (0) No error
ioErr (-36) I/O error
fnfErr (-43 File or directory does not 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
Note: There is a second, asynchronous, version of this function. It does not take a
second parameter; instead, it adds the suffix "Async" to the name of the
routine.
Similarly, the third (synchronous) version of the routine does not take a
second parameter; instead, it adds the suffix "Sync" to the name of the
routine.
Note, however, that the second and third versions of these routines do not
use the glue code that the first versions use and are therefore more
efficient.