Home / Autodocs / dos.library
NAME
- ExAllEnd
-
Stop an ExAll() (V39)
SYNOPSIS
ExAllEnd(lock, buffer, size, type, control)
ExAllEnd(BPTR,STRPTR,LONG,LONG,struct ExAllControl *)
D1 D2 D3 D4 D5
FUNCTION
Stops an ExAll() on a directory before it hits NO_MORE_ENTRIES. The full set of arguments that had been passed to ExAll() must be passed to ExAllEnd(), so it can handle file systems that cannot abort an ExAll() directly.
INPUTS
- lock
-
Lock on directory to be examined.
- buffer
-
Buffer for data returned (MUST be at least word-aligned, preferably long-word aligned).
- size
-
Size in bytes of 'buffer'.
- type
-
Type of data to be returned.
- control
-
Control data structure (see notes above). MUST have been allocated by AllocDosObject!
NOTES
Some file systems, e.g. network file systems, may still be busy processing directory records when you stop calling ExAll(). ExAllEnd() could be the fastest way to make them stop, releasing any resources currently tied up with preparing directory records which will not be needed.
Not all file systems directly support ExAll() and even fewer file systems directly support ExAllEnd(). ExAllEnd() may have to be emulated by dos.library, which may not accomplish what you intended. Instead of aborting the scanning operation immediately, the ExAllEnd() emulation will have to continue invoking ExAll() until the very last entry has been processed.
If the file system cannot abort an ExAll() directly, ExAllEnd() will keep calling ExAll() over and over again until it eventually hits NO_MORE_ENTRIES. This may not be what you want, because the alternative, to stop calling ExAll() and to not call ExAllEnd(), might be finished more quickly.
Not all file systems directly support ExAll() and even fewer file systems directly support ExAllEnd(). ExAllEnd() may have to be emulated by dos.library, which may not accomplish what you intended. Instead of aborting the scanning operation immediately, the ExAllEnd() emulation will have to continue invoking ExAll() until the very last entry has been processed.
If the file system cannot abort an ExAll() directly, ExAllEnd() will keep calling ExAll() over and over again until it eventually hits NO_MORE_ENTRIES. This may not be what you want, because the alternative, to stop calling ExAll() and to not call ExAllEnd(), might be finished more quickly.