This function retrieves information about the specified file.
At a Glance
| Header file: | Winbase.h |
| Windows CE versions: | 1.0 and later |
Syntax
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.
See Also