SetupGetSourceInfoA 函式 (setupapi.h)
[此函式可用於需求一節中所述的操作系統。 它在後續版本中可能會變更或無法使用。 安裝程式API不應再用於安裝應用程式。 請改用 Windows Installer 來開發應用程式安裝程式。 SetupAPI 會繼續用於安裝設備驅動器。]
SetupGetSourceInfo 函式會擷取 INF 檔案中所列來源的路徑、標記檔案或媒體描述。
語法
WINSETUPAPI BOOL SetupGetSourceInfoA(
[in] HINF InfHandle,
[in] UINT SourceId,
[in] UINT InfoDesired,
[in, out] PSTR ReturnBuffer,
[in] DWORD ReturnBufferSize,
[in, out] PDWORD RequiredSize
);
參數
[in] InfHandle
處理包含 SourceDisksNames 區段的開啟 INF 檔案。 如果用戶的系統 (存在平臺特定區段,例如 SourceDisksNames.x86) ,則會使用平臺特定區段。
[in] SourceId
來源媒體的標識碼。 此值用來依 SourceDisksNames 區段中的索引鍵進行搜尋。
[in] InfoDesired
指出所需的資訊。 每個函數調用只能指定一個值,而且無法合併。 您可以從 SourceDisksNames 區段擷取下列資訊類型。
SRCINFO_PATH
為來源指定的路徑。 這不是完整路徑,而是相對於安裝根目錄的路徑。
SRCINFO_TAGFILE
識別來源媒體的標記檔案,或者如果使用封包,則為封包檔案的名稱。
SRCINFO_DESCRIPTION
媒體的描述。
[in, out] ReturnBuffer
要接收所擷取信息的緩衝區選擇性指標。 路徑傳回保證不會以 結尾。 您應該使用 以 Null 結尾的字串。 以 Null 結束的字串不應超過目的地緩衝區的大小。 您可以呼叫函式一次以取得所需的緩衝區大小、配置必要的記憶體,然後再次呼叫函式以擷取數據。 請參閱<備註>一節。 使用這項技術,您可以避免因為緩衝區大小不足而發生錯誤。 此參數可以是 Null。
[in] ReturnBufferSize
ReturnBuffer 所指向的緩衝區大小,以字元為單位。 這包括 Null 終止符。
[in, out] RequiredSize
可接收 ReturnBuffer 所指定緩衝區大小之變數的選擇性指標,以字元為單位。 這包括 Null 終止符。 如果指定 ReturnBuffer ,而且所需的實際大小大於 ReturnBufferSize 所指定的值,則函式會失敗,而且 GetLastError 的呼叫會傳回ERROR_INSUFFICIENT_BUFFER。
傳回值
如果函式成功,則傳回值是非零值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
如果使用 NULL 的 ReturnBuffer 和 Zero 的 ReturnBufferSize 呼叫此函式,此函式會將所需的緩衝區大小放入 RequiredSize 所指向的變數中。 如果函式成功,則傳回值是非零值。 否則,傳回值為零,而且呼叫 GetLastError 即可取得擴充錯誤資訊。
注意
setupapi.h 標頭會將 SetupGetSourceInfo 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | setupapi.h |
程式庫 | Setupapi.lib |
Dll | Setupapi.dll |