rom/dos/close.c

   1 /*
   2     Copyright © 1995-2011, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8
   9 #include <proto/exec.h>
  10 #include <dos/dosextens.h>
  11
  12 #include <proto/dos.h>
  13 #include "dos_intern.h"
  14 #include <aros/debug.h>
  15
  16 /*****************************************************************************
  17
  18     NAME */
  19 #include <proto/dos.h>
  20
  21         AROS_LH1(BOOL, Close,
  22
  23 /*  SYNOPSIS */
  24         AROS_LHA(BPTR, file, D1),
  25
  26 /*  LOCATION */
  27         struct DosLibrary *, DOSBase, 6, Dos)
  28
  29 /*  FUNCTION
  30         Close a filehandle opened with Open(). If the file was used
  31         with buffered I/O the final write may fail and thus Close()
  32         return an error. The file is closed in any case.
  33
  34     INPUTS
  35         file  --  filehandle
  36
  37     RESULT
  38         0 if there was an error. != 0 on success.
  39
  40     NOTES
  41
  42     EXAMPLE
  43
  44     BUGS
  45
  46     SEE ALSO
  47
  48     INTERNALS
  49
  50 *****************************************************************************/
  51 {
  52     AROS_LIBFUNC_INIT
  53
  54     /* Get pointer to filehandle */
  55     struct FileHandle *fh = (struct FileHandle *)BADDR(file);
  56     /* The returncode defaults to OK. */
  57     BOOL ret = 1;
  58
  59     D(bug("[Close] %p: fh = %p\n", file, fh));
  60     ASSERT_VALID_PTR_OR_NULL(fh);
  61
  62     /* 0 handles are OK */
  63     if(file == BNULL)
  64         return ret;
  65
  66     /* Func3 == -1: file was already closed. */
  67     if (fh->fh_Func3 == -1)
  68         Alert(AN_FileReclosed);
  69
  70     /* If the filehandle has a pending write on it Flush() the buffer. */
  71     if(fh->fh_Flags & FHF_WRITE)
  72         ret = Flush(file);
  73
  74     ret = dopacket1(DOSBase, NULL, fh->fh_Type, ACTION_END, fh->fh_Arg1);
  75
  76     /* Free the filehandle which was allocated in Open(), CreateDir()
  77        and such. */
  78     fh->fh_Func3 = -1;
  79     FreeDosObject(DOS_FILEHANDLE, fh);
  80
  81     return ret;
  82
  83     AROS_LIBFUNC_EXIT
  84 } /* Close */