Функция GetFileInformationByHandle (fileapi.h)

  • Статья

Извлекает сведения о файле для указанного файла.

Более расширенную версию этой функции см. в разделе GetFileInformationByHandleEx.

Сведения о файле с помощью дескриптора файла см. в разделе SetFileInformationByHandle.

Синтаксис

BOOL GetFileInformationByHandle(
  [in]  HANDLE                       hFile,
  [out] LPBY_HANDLE_FILE_INFORMATION lpFileInformation
);

Параметры

[in] hFile

Дескриптор файла, который содержит извлекаемые сведения.

Этот дескриптор не должен быть дескриптором канала.

[out] lpFileInformation

Указатель на структуру BY_HANDLE_FILE_INFORMATION , которая получает сведения о файле.

Возвращаемое значение

Если функция выполняется успешно, возвращаемое значение не равно нулю, а данные файлов содержатся в буфере, на который указывает параметр lpFileInformation .

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Комментарии

В зависимости от базовых сетевых функций операционной системы и типа сервера, подключенного к, функция GetFileInformationByHandle может завершиться ошибкой, возвратить частичные или полные сведения для заданного файла.

Можно сравнить элементы VolumeSerialNumber и FileIndex , возвращенные в структуре BY_HANDLE_FILE_INFORMATION , чтобы определить, сопоставлены ли два пути с одной и той же целевой платформой; Например, можно сравнить два пути к файлам и определить, сопоставлены ли они с тем же каталогом.

В Windows 8 и Windows Server 2012 эта функция поддерживается следующими технологиями.

Технология Поддерживается
Протокол SMB 3.0 Да
SMB 3.0 Transparent Failover (TFO) Да
SMB 3.0 с масштабируемыми общими папками (SO) Да
Файловая система общего тома кластера (CSVFS) Да
Восстанавливаемая файловая система (ReFS) Да
 

Транзакция операций

Если транзакция привязана к потоку во время вызова, функция возвращает размер сжатого файла изолированного представления файлов. Дополнительные сведения см. в разделе Сведения о транзакционной ntfs.

Требования

Требование Значение
Минимальная версия клиента Windows XP [только классические приложения]
Минимальная версия сервера Windows Server 2003 [только классические приложения]
Целевая платформа Windows
Header fileapi.h (включая Windows.h)
Библиотека Kernel32.lib
DLL Kernel32.dll

См. также

Функции управления файлами

GetFileInformationByHandleEx

SetFileInformationByHandle