GetLogFileInformation 函式 (clfsw32.h)
傳回緩衝區,其中包含所指定記錄檔及其目前狀態的相關元數據,由 CLFS_INFORMATION 結構所定義。
取得的數據只會在進行呼叫時反映記錄檔的狀態。 一般而言,用戶端可以繼續快取並使用這個結構的欄位,直到下次附加記錄或寫入其重新啟動區域為止。 此時,某些資訊會變得過時。
語法
CLFSUSER_API BOOL GetLogFileInformation(
[in] HANDLE hLog,
[in, out] PCLFS_INFORMATION pinfoBuffer,
[in, out] PULONG cbBuffer
);
參數
[in] hLog
從成功呼叫 CreateLogFile 取得之開啟記錄檔的句柄。
記錄句柄可以參考專用或多任務記錄。
[in, out] pinfoBuffer
接收記錄元數據的使用者配置 CLFS_INFORMATION 結構的指標。
[in, out] cbBuffer
輸入上變數的指標會指定 pinfoBuffer 所指向之元數據緩衝區的大小,以位元組為單位。
輸出時,它會指定實際複製到 pinfoBuffer 的位元元組數目。
傳回值
如果函式成功,則傳回非零的值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
下列清單會識別可能的錯誤碼:
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 R2 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | clfsw32.h |
程式庫 | Clfsw32.lib |
Dll | Clfsw32.dll |