GetFileInformationByHandle
The GetFileInformationByHandle
function retrieves information about a specified file.
BOOL GetFileInformationByHandle(
|
HANDLE hFile, |
//
handle of file |
|
LPBY_HANDLE_FILE_INFORMATION lpFileInformation |
//
address of structure |
|
); |
|
Parameters
hFile
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
Points 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
If the
function succeeds, the return value is nonzero.
If the
function fails, the return value is zero. 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 given 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