Home / Autodocs / dos.library
NAME
- SetComment
-
Change a files' comment string
SYNOPSIS
success = SetComment( name, comment )
D0 D1 D2
BOOL SetComment(STRPTR, STRPTR)
D0 D1 D2
BOOL SetComment(STRPTR, STRPTR)
FUNCTION
SetComment() sets a comment on a file or directory. The comment is a pointer to a null-terminated string of up to 79 characters in the current ROM file system (and RAM:). Note that not all file systems will support comments, or the size of comment supported may vary.
INPUTS
- name
-
pointer to a null-terminated string
- comment
-
pointer to a null-terminated string
RESULT
- success
-
boolean; FALSE for failure, call IoErr() to find out why SetComment() has failed.