FindFirstFile

  • Article

This function searches a directory for a file or subdirectory whose name matches the specified file name.

A RAPI version of this function exists, called CeFindFirstFile (RAPI).

HANDLE FindFirstFile(
  LPCTSTR lpFileName, 
  LPWIN32_FIND_DATA lpFindFileData 
);

Parameters

  • lpFileName
    [in] Pointer to a null-terminated string that specifies a valid directory or path and file name, which can contain wildcard characters, such as * and ?.

    There is a default string size limit for paths of MAX_PATH characters. This limit is related to how the FindFirstFile function parses paths.

  • lpFindFileData
    [out] Pointer to the WIN32_FIND_DATA structure that receives information about the found file or subdirectory.

Return Values

A search handle, used in a subsequent call to FindNextFile or FindClose, indicates success. INVALID_HANDLE_VALUE indicates failure. To get extended error information, call GetLastError.

Remarks

The FindFirstFile function opens a search handle and returns information about the first file whose name matches the specified pattern. Once the search handle is established, you can use the FindNextFile function to search for other files that match the same pattern. When the search handle is no longer needed, close it by using the FindClose function.

This function searches for files by name only; it cannot be used for attribute-based searches.

Requirements

OS Versions: Windows CE 1.0 and later.
Header: Winbase.h.
Link Library: Coredll.lib.

See Also

CeFindFirstFile (RAPI) | FindClose | FindNextFile | GetFileAttributes | WIN32_FIND_DATA | FindFirstFileEx

 Last updated on Friday, April 09, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.