en:docs:fapi:dosfindclose

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

en:docs:fapi:dosfindclose [2018/08/30 15:37] (current)
prokushev created
Line 1: Line 1:
  
 +This call closes the association between a directory handle and a [[DosFindFirst (FAPI)|DosFindFirst]] or [[DosFindNext (FAPI)|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===
 +<PRE>
 +#define INCL_DOSFILEMGR
 +
 +USHORT ​ rc = DosFindClose(DirHandle);​
 +
 +HDIR    DirHandle; ​    /* Directory search handle */
 +USHORT ​ rc;            /* return code */
 +</​PRE>​
 +
 +===MASM Binding===
 +<PRE>
 +EXTRN  DosFindClose:​FAR
 +INCL_DOSFILEMGR ​    EQU 1
 +
 +PUSH   ​WORD ​   DirHandle ​    ;​Directory search handle
 +CALL   ​DosFindClose
 +
 +Returns WORD
 +</​PRE>​
 +
 +==Example==
 +This example searches for a file, then closes the search.
 +<PRE>
 +#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 */
 +</​PRE>​
 +
 +
 +
 +
 +====== Note ======
 +
 +Text based on [[http://​www.edm2.com/​index.php/​DosFindClose_(OS/​2_1.x)]]
 +
 +{{page>​en:​templates:​fapi}}

en/docs/fapi/dosfindclose.txt · Last modified: 2018/08/30 15:37 by prokushev