DosFindClose (OS/2 1.x)

Legacy Function Warning
It is recommended to use a newer replacement for this function.
Replacement:	DosFindClose
Remarks:	This page list the older version of the function for reference.

This call closes the association between a directory handle and a DosFindFirst or DosFindNext directory search function.

Syntax

DosFindClose (DirHandle)

Parameters

DirHandle (HDIR) - input

bHandle previously associated with a DosFindFirst by the system, or used with a DosFindNext directory search function.

Return Code

rc (USHORT) - return

Return code descriptions are:

• 0 NO_ERROR
• 6 ERROR_INVALID_HANDLE Remarks

Remarks

When DosFindClose is issued, a subsequent DosFindNext for the closed DirHandle fails unless an intervening DosFindFirst has been issued specifying DirHandle.

Bindings

C Binding

#define INCL_DOSFILEMGR

USHORT  rc = DosFindClose(DirHandle);

HDIR    DirHandle;     /* Directory search handle */
USHORT  rc;            /* return code */

MASM Binding

EXTRN  DosFindClose:FAR
INCL_DOSFILEMGR     EQU 1

PUSH   WORD    DirHandle     ;Directory search handle
CALL   DosFindClose

Returns WORD

Example

This example searches for a file, then closes the search.

#define INCL_DOSFILEMGR
#define SEARCH_PATTERN "*.*"
#define FILE_ATTRIBUTE 0
#define RESERVED 0L

HDIR  FindHandle;

   FindHandle = 0x0001;
   FindCount = 1;

   rc = DosFindFirst(SEARCH_PATTERN,        /* File pattern */
                     &FindHandle,           /* Directory search handle */
                     FILE_ATTRIBUTE,        /* Search attribute */
                     &FindBuffer,           /* Result buffer */
                     sizeof(FindBuffer),    /* Result buffer length */
                     &FindCount,            /* # of entries to find */
                     RESERVED);             /* Reserved (must be zero) */
   rc = DosFindClose(FindHandle);           /* Directory search handle */