rom/dos/close.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   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 #include <aros/debug.h>
  14
  15 /*****************************************************************************
  16
  17     NAME */
  18 #include <proto/dos.h>
  19
  20         AROS_LH1(BOOL, Close,
  21
  22 /*  SYNOPSIS */
  23         AROS_LHA(BPTR, file, D1),
  24
  25 /*  LOCATION */
  26         struct DosLibrary *, DOSBase, 6, Dos)
  27
  28 /*  FUNCTION
  29         Close a filehandle opened with Open(). If the file was used
  30         with buffered I/O the final write may fail and thus Close()
  31         return an error. The file is closed in any case.
  32
  33     INPUTS
  34         file  --  filehandle
  35
  36     RESULT
  37         0 if there was an error. != 0 on success.
  38
  39     NOTES
  40         This function is identical to UnLock().
  41
  42     EXAMPLE
  43
  44     BUGS
  45
  46     SEE ALSO
  47
  48     INTERNALS
  49
  50 *****************************************************************************/
  51
  52 /*****************************************************************************
  53
  54     NAME
  55 #include <clib/dos_protos.h>
  56
  57         AROS_LH1(BOOL, UnLock,
  58
  59     SYNOPSIS
  60         AROS_LHA(BPTR, lock, D1),
  61
  62     LOCATION
  63         struct DosLibrary *, DOSBase, 15, Dos)
  64
  65     FUNCTION
  66         Free a lock created with Lock().
  67
  68     INPUTS
  69         lock -- The lock to free
  70
  71     RESULT
  72
  73     NOTES
  74         This function is identical to Close() - see there.
  75
  76     EXAMPLE
  77
  78     BUGS
  79
  80     SEE ALSO
  81
  82     INTERNALS
  83
  84 *****************************************************************************/
  85 /*AROS alias UnLock Close */
  86 {
  87     AROS_LIBFUNC_INIT
  88
  89     /* Get pointer to filehandle */
  90     struct FileHandle *fh = (struct FileHandle *)BADDR(file);
  91
  92     /* Get space for I/O request. Use stack for now. */
  93     struct IOFileSys iofs;
  94
  95     /* The returncode defaults to OK. */
  96     BOOL ret = 1;
  97
  98     ASSERT_VALID_PTR_OR_NULL(fh);
  99
 100     /* 0 handles are OK */
 101     if(file == BNULL)
 102         return ret;
 103
 104     /* If the filehandle has a pending write on it Flush() the buffer. */
 105     if(fh->fh_Flags & FHF_WRITE)
 106         ret = Flush(file);
 107
 108     /* Prepare I/O request. */
 109     InitIOFS(&iofs, FSA_CLOSE, DOSBase);
 110
 111     iofs.IOFS.io_Device = fh->fh_Device;
 112     iofs.IOFS.io_Unit   = fh->fh_Unit;
 113
 114     /* Send the request. No errors possible. */
 115     DosDoIO(&iofs.IOFS);
 116
 117     /* Free the filehandle which was allocated in Open(), CreateDir()
 118        and such. */
 119     FreeDosObject(DOS_FILEHANDLE, fh);
 120
 121     return ret;
 122
 123     AROS_LIBFUNC_EXIT
 124 } /* Close */