Inside Macintosh: 3D Graphics Programming With QuickDraw 3D /

Chapter 17 - File Objects / File Objects Reference

File Objects Routines / Reading and Writing File Data

Q3Comment_Write

You can use the Q3Comment_Write function to write a comment to a file object.

TQ3Status Q3Comment_Write (
char *comment, 
TQ3FileObject file);

comment

A pointer to a null-terminated C string.

file

A file object.

DESCRIPTION

The Q3Comment_Write function writes the string of characters pointed to by the comment parameter to the file object specified by the file parameter. QuickDraw 3D currently supports writing comments to text files only; if you call Q3Comment_Write to write a comment to a binary file, QuickDraw 3D ignores the call. In addition, you cannot currently use QuickDraw 3D to read comments from a file.