SetupQueryFileLogW 函式 (setupapi.h)
[此函式可用於需求一節所指出的作業系統。 後續版本可能會變更或無法使用。 安裝程式API 不應該再用於安裝應用程式。 請改用 Windows Installer 來開發應用程式安裝程式。 SetupAPI 會繼續用於安裝設備驅動器。]
SetupQueryFileLog 函式會從安裝程式檔案記錄傳回資訊。
語法
WINSETUPAPI BOOL SetupQueryFileLogW(
[in] HSPFILELOG FileLogHandle,
[in] PCWSTR LogSectionName,
[in] PCWSTR TargetFilename,
[in] SetupFileLogInfo DesiredInfo,
[in, out] PWSTR DataOut,
[in] DWORD ReturnBufferSize,
[in, out] PDWORD RequiredSize
);
參數
[in] FileLogHandle
SetupInitializeFileLog所傳回的檔案記錄檔句柄。
[in] LogSectionName
記錄檔區段名稱的選擇性指標,其格式對呼叫端有意義。 您應該使用 null-terminated 字串。 非系統記錄的必要專案。 如果未指定 logSectionName
[in] TargetFilename
需要記錄信息的檔名。 您應該使用 null-terminated 字串。
[in] DesiredInfo
指出應該傳回至 DataOut 緩衝區的資訊。 此參數可以是下列其中一個列舉值。
如果 desiredInfo
[in, out] DataOut
這個函式會傳回檔案要求信息的緩衝區選擇性指標。 您應該使用 null-terminated 字串。
null終止字串不應超過目的地緩衝區的大小。 您可以呼叫函式一次以取得所需的緩衝區大小、配置必要的記憶體,然後第二次呼叫函式來擷取數據。 請參閱一節。 使用這項技術,您可以避免因為緩衝區大小不足而發生錯誤。 並非每個檔案都提供所有資訊。 如果檔案的空白專案存在於記錄檔中,則不會傳回錯誤。 此參數可以是 NULL
[in] ReturnBufferSize
DataOut 緩衝區的大小,以字元為單位。 這包括 null 終止符。 如果緩衝區太小且 指定 DataOut,則不會將數據儲存在緩衝區中,且函式會傳回零。 如果未指定
[in, out] RequiredSize
選擇性的指標,此變數會以字元為單位接收 DataOut的必要大小。 此數位包含 null 終止符。
傳回值
如果函式成功,則傳回值是非零值。
如果函式失敗,傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
言論
如果使用 NULL 的 DataOut 呼叫此函式,且 ReturnBufferSize 為零,則函式會將所需的緩衝區大小放入 RequiredSize所指向的變數中。 如果函式成功,則傳回值是非零值。 否則,傳回值為零,而且可以呼叫 getLastError
如果 desiredInfo
注意
setupapi.h 標頭會將 SetupQueryFileLog 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
支援的最低伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | setupapi.h |
連結庫 | Setupapi.lib |
DLL | Setupapi.dll |