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