PBDTGetCommentSync
DTPBPtr paramBlock ; pointer to a DTPB Param Block
Boolean async; 0 = await completion; 1 = immediate return PBDTGetComment 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
buffer as a plain text string and places the length of the comment in
Parameter block
ۮ 12 ioCompletion long completion routine
۬ 16 ioResult short result code
ۮ 18 ioNamePtr long pointer to file or directory name
ۮ 24 ioDTRefNum short desktop database reference number
ۮ 32 ioDTBuffer long pointer to comment text (200 bytes)
۬ 40 ioDTActCount long comment size
ۮ 48 ioDirID long parent directory of file or directory
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
rfNumErr (-51) Reference number invalid
extFSErr (-58) External file system-file system identifier is nonzero
afpItemNotFound (-5012) Information 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.