Share via

GetFileInformationByHandle

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves information about the specified file.

Syntax

BOOL GetFileInformationByHandle( 
  HANDLE hFile, 
  LPBY_HANDLE_FILE_INFORMATION lpFileInformation
);

Parameters

  • hFile
    [in] Handle to the file about which you want to obtain information.

    This handle should not be a pipe handle. This function does not operate with pipe handles.

  • lpFileInformation
    [out] Pointer to a BY_HANDLE_FILE_INFORMATION structure that receives the file information. The structure can be used in subsequent calls to this function to refer to the information about the file.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

Depending on the underlying network components of the OS and the type of server to which it is connected, this function can fail, return partial information, or full information for the specified file. In general, do not use this function unless your application runs on a limited set of OS configurations.

Requirements

Header winbase.h
Library coredll.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

File I/O Functions
BY_HANDLE_FILE_INFORMATION
GetFileAttributes
FindFirstFile