Edit

Share via

FILE_INFO_BY_HANDLE_CLASS enumeration (minwinbase.h)

  • Article

Identifies the type of file information that GetFileInformationByHandleEx should retrieve or SetFileInformationByHandle should set.

Syntax

typedef enum _FILE_INFO_BY_HANDLE_CLASS {
  FileBasicInfo,
  FileStandardInfo,
  FileNameInfo,
  FileRenameInfo,
  FileDispositionInfo,
  FileAllocationInfo,
  FileEndOfFileInfo,
  FileStreamInfo,
  FileCompressionInfo,
  FileAttributeTagInfo,
  FileIdBothDirectoryInfo,
  FileIdBothDirectoryRestartInfo,
  FileIoPriorityHintInfo,
  FileRemoteProtocolInfo,
  FileFullDirectoryInfo,
  FileFullDirectoryRestartInfo,
  FileStorageInfo,
  FileAlignmentInfo,
  FileIdInfo,
  FileIdExtdDirectoryInfo,
  FileIdExtdDirectoryRestartInfo,
  FileDispositionInfoEx,
  FileRenameInfoEx,
  FileCaseSensitiveInfo,
  FileNormalizedNameInfo,
  MaximumFileInfoByHandleClass
} FILE_INFO_BY_HANDLE_CLASS, *PFILE_INFO_BY_HANDLE_CLASS;

Constants

 
FileBasicInfo
Minimal information for the file should be retrieved or set. Used for file handles. See
FILE_BASIC_INFO.
FileStandardInfo
Extended information for the file should be retrieved. Used for file handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_STANDARD_INFO.
FileNameInfo
The file name should be retrieved. Used for any handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_NAME_INFO.
FileRenameInfo
The file name should be changed. Used for file handles. Use only when calling
SetFileInformationByHandle. See
FILE_RENAME_INFO.
FileDispositionInfo
The file should be deleted. Used for any handles. Use only when calling
SetFileInformationByHandle. See
FILE_DISPOSITION_INFO.
FileAllocationInfo
The file allocation information should be changed. Used for file handles. Use only when calling
SetFileInformationByHandle. See
FILE ALLOCATION INFO.
FileEndOfFileInfo
The end of the file should be set. Use only when calling
SetFileInformationByHandle. See
FILE_END_OF_FILE_INFO.
FileStreamInfo
File stream information for the specified file should be retrieved. Used for any handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_STREAM_INFO.
FileCompressionInfo
File compression information should be retrieved. Used for any handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_COMPRESSION_INFO.
FileAttributeTagInfo
File attribute information should be retrieved. Used for any handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_ATTRIBUTE_TAG_INFO.
FileIdBothDirectoryInfo
Files in the specified directory should be retrieved. Used for directory handles. Use only when calling
GetFileInformationByHandleEx. The number
of files returned for each call to
GetFileInformationByHandleEx depends on
the size of the buffer that is passed to the function. Any subsequent calls to
GetFileInformationByHandleEx on the same
handle will resume the enumeration operation after the last file is returned. See
FILE_ID_BOTH_DIR_INFO.
FileIdBothDirectoryRestartInfo
Identical to FileIdBothDirectoryInfo, but forces the enumeration operation to
start again from the beginning. See
FILE_ID_BOTH_DIR_INFO.
FileIoPriorityHintInfo
Priority hint information should be set. Use only when calling
SetFileInformationByHandle. See
FILE_IO_PRIORITY_HINT_INFO.
FileRemoteProtocolInfo
File remote protocol information should be retrieved. Use for any handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_REMOTE_PROTOCOL_INFO.
FileFullDirectoryInfo
Files in the specified directory should be retrieved. Used for directory handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_FULL_DIR_INFO.

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP:  This value is not supported before Windows 8 and Windows Server 2012
FileFullDirectoryRestartInfo
Identical to FileFullDirectoryInfo, but forces the enumeration operation to
start again from the beginning. Use only when calling
GetFileInformationByHandleEx. See
FILE_FULL_DIR_INFO.

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP:  This value is not supported before Windows 8 and Windows Server 2012
FileStorageInfo
File storage information should be retrieved. Use for any handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_STORAGE_INFO.

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP:  This value is not supported before Windows 8 and Windows Server 2012
FileAlignmentInfo
File alignment information should be retrieved. Use for any handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_ALIGNMENT_INFO.

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP:  This value is not supported before Windows 8 and Windows Server 2012
FileIdInfo
File information should be retrieved. Use for any handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_ID_INFO.

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP:  This value is not supported before Windows 8 and Windows Server 2012
FileIdExtdDirectoryInfo
Files in the specified directory should be retrieved. Used for directory handles. Use only when calling
GetFileInformationByHandleEx. See
FILE_ID_EXTD_DIR_INFO.

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP:  This value is not supported before Windows 8 and Windows Server 2012
FileIdExtdDirectoryRestartInfo
Identical to FileIdExtdDirectoryInfo, but forces the enumeration operation to
start again from the beginning. Use only when calling
GetFileInformationByHandleEx. See
FILE_ID_EXTD_DIR_INFO.

Windows Server 2008 R2, Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP:  This value is not supported before Windows 8 and Windows Server 2012
FileDispositionInfoEx
FileRenameInfoEx
MaximumFileInfoByHandleClass
This value is used for validation. Supported values are less than this value.

Remarks

As noted in the preceding section, some file information classes are valid only for use with GetFileInformationByHandleEx. Others are valid only for use with SetFileInformationByHandle. Where neither function is mentioned, the information class is valid with both functions.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Header minwinbase.h (include Windows.h)
Redistributable Windows SDK on Windows Server 2003 and Windows XP.

See also

GetFileInformationByHandleEx

SetFileInformationByHandle