SetupGetStringFieldA 函式 (setupapi.h)
[此函式可用於需求一節中所述的操作系統。 它在後續版本中可能會變更或無法使用。 安裝程式API不應再用於安裝應用程式。 請改用 Windows Installer 來開發應用程式安裝程式。 SetupAPI 會繼續用於安裝設備驅動器。]
SetupGetStringField 函式會從 INF 檔案中某行的指定欄位擷取字串。
語法
WINSETUPAPI BOOL SetupGetStringFieldA(
[in] PINFCONTEXT Context,
[in] DWORD FieldIndex,
[in, out] PSTR ReturnBuffer,
[in] DWORD ReturnBufferSize,
[out] PDWORD RequiredSize
);
參數
[in] Context
INF 檔案中某行內容的指標。
[in] FieldIndex
指定行內應從中擷取字串之字段的 1 型索引。 如果有的話，請使用 0 的 FieldIndex 來擷取字串索引鍵。
[in, out] ReturnBuffer
接收 Null 終止字串之緩衝區的選擇性指標。 您應該確定目的地緩衝區的大小或大於來源緩衝區。 此參數可以是 Null。 請參閱＜備註＞一節。
[in] ReturnBufferSize
ReturnBuffer 所指向的緩衝區大小，以字元為單位。 這包括 Null 終止符。
[out] RequiredSize
選擇性的指標，這個變數會接收 ReturnBuffer 參數所指向之緩衝區的必要大小，以字元為單位。 如果指定 ReturnBuffer ，而且所需的實際大小大於 ReturnBufferSize 所指定的值，則函式會失敗，而且不會將字串儲存在緩衝區中。 在此情況下， 呼叫 GetLastError 會傳回ERROR_INSUFFICIENT_BUFFER。 對於此函式的 Unicode 版本，所需的大小是以字元為單位。 這包括 Null 終止符。
傳回值
如果函式成功，則傳回值是非零值。
如果此函式失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。
備註
如果使用 NULL 的 ReturnBuffer 和 Zero 的 ReturnBufferSize 呼叫此函式，此函式會將所需的緩衝區大小放入 RequiredSize 所指向的變數中。 如果函式成功，則傳回值是非零值。 否則，傳回值為零，而且呼叫 GetLastError 即可取得擴充錯誤資訊。
您可以呼叫函式一次以取得所需的緩衝區大小、配置必要的記憶體，然後再次呼叫函式以擷取數據。 使用這項技術，您可以避免因為緩衝區大小不足而發生錯誤。
請注意，INF Strings 區段中指定之任何單一字串的最大長度為 512 個字元，包括終止 的 NULL。 如果字串長度大於 512，則會截斷，而且不會傳回任何錯誤。 從一或多個 %strkey% 標記建立的任何串連字串長度上限為 4096 個字元。
注意
setupapi.h 標頭會將 SetupGetStringField 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 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 版) |