GetFileInformationByHandle

This function retrieves information about the specified file.

BOOL GetFileInformationByHandle( 
HANDLE hFile, 
LPBY_HANDLE_FILE_INFORMATION lpFileInformation);

Parameters

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

  This handle should not be a pipe handle. The GetFileInformationByHandle function does not work 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 GetFileInformationByHandle to refer to the information about the file.

Return Values

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

Remarks

Depending on the underlying network components of the operating system and the type of server connected to, the GetFileInformationByHandle function may fail, return partial information, or full information for the specified file. In general, you should not use GetFileInformationByHandle unless your application is intended to be run on a limited set of operating system configurations.

Requirements

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

GetLastError, BY_HANDLE_FILE_INFORMATION

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.