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 函式可能會失敗、傳回部分資訊或指定檔案的完整資訊。

您可以比較BY_HANDLE_FILE_INFORMATION結構中傳回的 VolumeSerialNumber 和 FileIndex 成員，以判斷兩個路徑是否對應至相同的目標;例如，您可以比較兩個檔案路徑，並判斷它們是否對應至相同的目錄。

IIn Windows 8 和 Windows Server 2012，下列技術支援此函式。

如果在呼叫時有系結至線程的交易，則函式會傳回隔離檔案檢視的壓縮檔案大小。如需詳細資訊，請參閱關於交易式NTFS。