SetupGetMultiSzFieldA 函式 (setupapi.h)
[此函式可用於需求一節中所述的操作系統。 它在後續版本中可能會變更或無法使用。 安裝程式API不應再用於安裝應用程式。 請改用 Windows Installer 來開發應用程式安裝程式。 SetupAPI 會繼續用於安裝設備驅動器。]
SetupGetMultiSzField 函式會從指定的欄位到行尾擷取儲存在 INF 檔案一行中的多個字元串。
語法
WINSETUPAPI BOOL SetupGetMultiSzFieldA(
[in] PINFCONTEXT Context,
[in] DWORD FieldIndex,
[in, out] PSTR ReturnBuffer,
[in] DWORD ReturnBufferSize,
[in] LPDWORD RequiredSize
);
參數
[in] Context
INF 檔案中行內容的指標。
[in] FieldIndex
要從中擷取字串之指定行內起始字段的 1 個索引。 字串清單是從這一點開始到行尾的每個欄位所建置。 此函式無效的 FieldIndex 為零。
[in, out] ReturnBuffer
接收字串之字元緩衝區的選擇性指標。 每個字串都是 以 Null 結束,在字串清單結尾加上額外的 Null 。 以 Null 結尾的字串不應超過目的地緩衝區的大小。 您可以呼叫函式一次,以取得所需的緩衝區大小、配置必要的記憶體,然後再次呼叫函式以擷取數據。 使用這項技術,您可以避免因為緩衝區大小不足而發生錯誤。 請參閱<備註>一節。 此參數可以是 Null。
[in] ReturnBufferSize
ReturnBuffer 所指向的緩衝區大小,以字元為單位。 這包括 Null 終止符。
[in] RequiredSize
變數的選擇性指標,以字元為單位,接收 ReturnBuffer 所指向之緩衝區所需的大小。 這包括 Null 終止符。 如果需要的大小大於 ReturnBufferSize 所指定的值,則函式會失敗,而且 GetLastError 的呼叫會傳回ERROR_INSUFFICIENT_BUFFER。
傳回值
如果函式成功,則傳回值是非零值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
如果使用 NULL 的 ReturnBuffer 和零的 ReturnBufferSize 呼叫此函式,此函式會將保留指定數據的緩衝區大小放入 RequiredSize 所指向的變數中。 如果函式成功,則傳回值是非零值。 否則,傳回值為零,而且呼叫 GetLastError 即可取得擴充錯誤資訊。
SetupGetMultiSzField 不應該用來逐一查看 INF 行上的字串值。 您應該改用 SetupGetStringField。 SetupGetMultiSzField 會以 REG_MULTI_SZ 格式傳回值。 這是以 Null 字元結尾的 Null 字串數位。 此格式不允許長度為零的字串。 如果字串清單包含任何零長度字串, 則 SetupGetMultiSzField 會在遇到第一個空白字串值時提前傳回。
注意
setupapi.h 標頭會根據 UNICODE 預處理器常數的定義,將 SetupGetMultiSzField 定義為別名,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | setupapi.h |
程式庫 | Setupapi.lib |
Dll | Setupapi.dll |
API 集合 | ext-ms-win-setupapi-inf-l1-1-1 (於 Windows 10 10.0.14393 版) |