rom/dos/setcomment.c

   1 /*
   2     Copyright © 1995-2008, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Set a filecomment.
   6     Lang: english
   7 */
   8 #include <proto/exec.h>
   9 #include <dos/dosextens.h>
  10 #include <dos/filesystem.h>
  11 #include <proto/dos.h>
  12 #include "dos_intern.h"
  13
  14 /*****************************************************************************
  15
  16     NAME */
  17 #include <proto/dos.h>
  18
  19         AROS_LH2(BOOL, SetComment,
  20
  21 /*  SYNOPSIS */
  22         AROS_LHA(CONST_STRPTR, name,    D1),
  23         AROS_LHA(CONST_STRPTR, comment, D2),
  24
  25 /*  LOCATION */
  26         struct DosLibrary *, DOSBase, 30, Dos)
  27
  28 /*  FUNCTION
  29         Change the comment on a file or directory. The comment may be any
  30         NUL-terminated string. The supported size varies from filesystem
  31         to filesystem. In order to clear an existing comment, an empty
  32         string should be specified.
  33
  34     INPUTS
  35         name    - name of the file
  36         comment - new comment for the file.
  37
  38     RESULT
  39         Boolean success indicator. IoErr() gives additional information upon
  40         failure.
  41
  42     NOTES
  43
  44     EXAMPLE
  45
  46     BUGS
  47
  48     SEE ALSO
  49
  50     INTERNALS
  51
  52 *****************************************************************************/
  53 {
  54     AROS_LIBFUNC_INIT
  55
  56     /* Get pointer to I/O request. Use stackspace for now. */
  57     struct IOFileSys iofs;
  58
  59     /* Prepare I/O request. */
  60     InitIOFS(&iofs, FSA_SET_COMMENT, DOSBase);
  61
  62     iofs.io_Union.io_SET_COMMENT.io_Comment = comment;
  63
  64     return DoIOFS(&iofs, NULL, name, DOSBase) == 0;
  65
  66     AROS_LIBFUNC_EXIT
  67 } /* SetComment */