SetupGetLineTextW 函式 (setupapi.h)
[此函式可用於需求一節所指出的作業系統。 後續版本可能會變更或無法使用。 安裝程式API 不應該再用於安裝應用程式。 請改用 Windows Installer 來開發應用程式安裝程式。 SetupAPI 會繼續用於安裝設備驅動器。]
SetupGetLineText 函式會以精簡格式傳回 INF 檔案中的一行內容。 要擷取的行可由 INFCONTEXT 結構指定,從 SetupFindLineXXX 函式傳回,或明確傳入所需行的 INF 句柄、區段和索引鍵。
語法
WINSETUPAPI BOOL SetupGetLineTextW(
[in] PINFCONTEXT Context,
[in] HINF InfHandle,
[in] PCWSTR Section,
[in] PCWSTR Key,
[in, out] PWSTR ReturnBuffer,
[in] DWORD ReturnBufferSize,
[in, out] PDWORD RequiredSize
);
參數
[in] Context
要擷取其文字之 INF 檔案中行的內容。 此參數可以是 NULL
[in] InfHandle
要查詢之 INF 檔案的句柄。 此參數可以是 NULL
[in] Section
null終止字串的指標,指定包含要擷取其文字之行索引鍵名稱的區段。 此參數可以是 NULL
[in] Key
null終止字串的指標,其中包含要擷取相關聯字串的索引鍵名稱。 此參數可以是 NULL
[in, out] ReturnBuffer
如果未 NULL,ReturnBuffer 會指向這個函式傳回該行內容的緩衝區。
null終止字串不能超過目的地緩衝區的大小。 您可以呼叫函式一次以取得所需的緩衝區大小、配置必要的記憶體,然後第二次呼叫函式來擷取數據。 使用這項技術,您可以避免因為緩衝區大小不足而發生錯誤。 請參閱一節。 此參數可以是 NULL
[in] ReturnBufferSize
ReturnBuffer 參數所指向的緩衝區大小,以字元為單位。 這包括 null 終止符。
[in, out] RequiredSize
如果未 NULL,則指向變數,在此變數中,此函式會傳回 ReturnBuffer 參數所指向之緩衝區所需的大小,以字元為單位。 這包括 null 終止符。 如果指定 ReturnBuffer,而且所需的大小大於 returnBufferSize 參數中所指定的值,則函式會失敗,而且不會將數據儲存在緩衝區中。
傳回值
如果函式成功,則傳回值是非零值。
如果函式失敗,傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
言論
如果使用 ReturnBuffer 呼叫此函式,NULL 和 ReturnBufferSize 為零,則函式會將所需的緩衝區大小,以 RequiredSize指向的變數中放置指定的數據。 如果函式成功,則傳回值是非零值。 否則,傳回值為零,而且可以呼叫 getLastError
此函式會以精簡格式傳回一行的內容。 拿掉所有多餘的空格符,並將多行值轉換成單一連續字串。 例如,這一行:
HKLM, , PointerClass0, 1 \
; This is a comment
01, 02, 03
會傳回為:
HKLM,,PointerClass0,1,01,02,03
注意
setupapi.h 標頭會將 SetupGetLineText 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
支援的最低伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | setupapi.h |
連結庫 | Setupapi.lib |
DLL | Setupapi.dll |
API 集 | ext-ms-win-setupapi-inf-l1-1-0 (在 Windows 8 中引進) |