SetupGetBinaryField 函式 (setupapi.h)
[此函式可用於需求一節中所述的作業系統。 它在後續版本中可能會變更或無法使用。 安裝程式API 不應再用於安裝應用程式。 請改用 Windows Installer 來開發應用程式安裝程式。 SetupAPI 會繼續用於安裝設備磁碟機。]
SetupGetBinaryField函式會從 INF 檔案區段中的一行擷取二進位資料,從指定的欄位擷取到行尾。
語法
WINSETUPAPI BOOL SetupGetBinaryField(
[in] PINFCONTEXT Context,
[in] DWORD FieldIndex,
[in, out] PBYTE ReturnBuffer,
[in] DWORD ReturnBufferSize,
[in, out] LPDWORD RequiredSize
);
參數
[in] Context
行的 INF 內容。
[in] FieldIndex
要從中擷取二進位資料之指定行內起始欄位的 1 個索引。 二進位資料是從每個欄位建置,從這一點開始到行尾。 每個欄位對應至 1 個位元組,並以十六進位標記法表示。 此函式不正確 FieldIndex 為零。
[in, out] ReturnBuffer
接收二進位資料的緩衝區選擇性指標。 您應該確定目的地緩衝區的大小或大於來源緩衝區。 您可以呼叫函式一次,以取得所需的緩衝區大小、配置必要的記憶體,然後再次呼叫函式以擷取資料。 使用這項技術,您可以避免因為緩衝區大小不足而發生錯誤。 請參閱<備註>一節。
[in] ReturnBufferSize
ReturnBuffer所指向的緩衝區大小,以字元為單位。 這個數位包含 Null 結束字元。
[in, out] RequiredSize
選擇性的變數指標,該變數會以字元為單位接收指向 ReturnBuffer之緩衝區的必要大小。 這個數位包含 Null 結束字元。 如果需要的大小大於 ReturnBufferSize所指定的值,則函式會失敗,而且 GetLastError 的呼叫會傳回ERROR_INSUFFICIENT_BUFFER。
傳回值
如果函式成功,則傳回值是非零值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
如果SetupGetBinaryField擷取的欄位不是 0-FF 範圍中的有效十六進位數位,GetLastError會傳回ERROR_INVALID_DATA。
備註
如果使用Null的ReturnBuffer 和零的 ReturnBufferSize呼叫此函式,此函式會將保留指定資料的緩衝區大小放入RequiredSize所指向的變數中。 如果函式成功,則傳回值是非零值。 否則,傳回值為零,而且呼叫 GetLastError即可取得擴充錯誤資訊。
若要進一步瞭解此函式的運作方式,請考慮 INF 檔案的下一行。
X=34,FF,00,13
如果在前一行呼叫 SetupGetBinaryField ,則會將二進位值 34、FF、00 和 13 放入 ReturnBuffer指定的緩衝區中。
針對此函式的 Unicode 版本,緩衝區大小 ReturnBufferSize 和 RequiredSize 是以字元數指定。 這個數位包含 Null 結束字元。 針對此函式的 ANSI 版本,大小會以位元組數目指定。
如果使用Null的ReturnBuffer 和零的 ReturnBufferSize呼叫此函式,此函式會將保留指定資料的緩衝區大小放入RequiredSize所指向的變數中。 如果函式成功,則傳回值是非零值。 否則,傳回值為零,而且呼叫 GetLastError即可取得擴充錯誤資訊。
因此,您可以呼叫函式一次以取得所需的緩衝區大小、配置必要的記憶體,然後第二次呼叫函式以擷取資料。 使用這項技術,您可以避免因為緩衝區大小不足而發生錯誤。
規格需求
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | setupapi.h |
程式庫 | Setupapi.lib |
Dll | Setupapi.dll |