rom/dos/exnext.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8
   9 #include <aros/debug.h>
  10 #include <proto/exec.h>
  11
  12 #include "dos_intern.h"
  13
  14 /*****************************************************************************
  15
  16     NAME */
  17 #include <proto/dos.h>
  18
  19         AROS_LH2(LONG, ExNext,
  20
  21 /*  SYNOPSIS */
  22         AROS_LHA(BPTR                  , lock, D1),
  23         AROS_LHA(struct FileInfoBlock *, fileInfoBlock, D2),
  24
  25 /*  LOCATION */
  26         struct DosLibrary *, DOSBase, 18, Dos)
  27
  28 /*  FUNCTION
  29         Examine the next entry in a directory.
  30
  31     INPUTS
  32         lock - lock on the direcory the contents of which to examine
  33         fib  - a FileInfoBlock previously initialized by Examine()
  34                (or used before with ExNext())
  35
  36     RESULT
  37         success  --  a boolean telling whether the operation was successful
  38                  or not. A failure occurs also if there is no "next" entry in
  39                  the directory. Then IoErr() equals ERROR_NO_MORE_ENTRIES.
  40
  41     NOTES
  42         If scanning a filesystem tree recursively, you'll need to allocate a
  43         new FileInfoBlock for each directory level.
  44
  45     EXAMPLE
  46         To examine a directory, do the following:
  47
  48         1.  Pass a lock on the directory and a FileInfoBlock (allocated by
  49             AllocDosObject()) to Examine().
  50         2.  Pass the same parameters to ExNext().
  51         3.  Do something with the FileInfoBlock returned.
  52         4.  Call ExNext() repeatedly until it returns FALSE and use the
  53             information you are provided. When ExNext returns FALSE, check
  54             IoErr() to make sure that there was no real failure
  55             (ERROR_NO_MORE_ENTRIES).
  56
  57     BUGS
  58
  59     SEE ALSO
  60         Examine(), IoErr(), AllocDosObject(), ExAll()
  61
  62     INTERNALS
  63
  64 *****************************************************************************/
  65 {
  66     AROS_LIBFUNC_INIT
  67
  68     /* Get pointer to filehandle */
  69     struct FileLock *fl = BADDR(lock);
  70     LONG ret;
  71
  72     ASSERT_VALID_PTR_OR_NULL(BADDR(lock));
  73     ASSERT_VALID_FILELOCK(lock);
  74
  75     D(bug("[ExNext] lock=%x fib=%x\n", fl, fileInfoBlock));
  76     ret = dopacket2(DOSBase, NULL,  fl->fl_Task, ACTION_EXAMINE_NEXT, lock, MKBADDR(fileInfoBlock));
  77     if (ret) {
  78         fixfib(fileInfoBlock);
  79         D(bug("[ExNext] '%s'\n", fileInfoBlock->fib_FileName));
  80     } else {
  81         D(bug("[ExNext] ret=%d err=%d\n", ret, IoErr()));
  82     }
  83     return ret;
  84
  85     AROS_LIBFUNC_EXIT
  86 } /* ExNext */