SetupDiGetHwProfileListExA 函式 (setupapi.h)

SetupDiGetHwProfileListEx 函式會擷取本機或遠端電腦上所有目前定義硬體設定檔標識碼的清單。

語法

WINSETUPAPI BOOL SetupDiGetHwProfileListExA(
  [out]           PDWORD HwProfileList,
  [in]            DWORD  HwProfileListSize,
  [out]           PDWORD RequiredSize,
  [out, optional] PDWORD CurrentlyActiveIndex,
  [in, optional]  PCSTR  MachineName,
                  PVOID  Reserved
);

參數

[out] HwProfileList

陣列的指標，用來接收目前定義的硬體配置檔識別符清單。

[in] HwProfileListSize

HwProfileList 緩衝區中的 DWORD 數目。

[out] RequiredSize

DWORD 類型的變數指標，可接收目前定義的硬體配置檔數目。 如果數位大於 HwProfileListSize，則會截斷清單以符合數位大小。 RequiredSize 中傳回的值表示儲存整個硬體配置檔清單所需的數位大小。

[out, optional] CurrentlyActiveIndex

在擷取的硬體配置檔清單中，接收目前作用中硬體配置檔索引的變數指標。 這個參數是選擇性的，而且可以是 NULL。

[in, optional] MachineName

NULL 終止字串的指標，其中包含要擷取硬體配置檔識別碼清單的遠端系統名稱。 這個參數是選擇性的，而且可以是 NULL。 如果此參數為 NULL，則會擷取本機系統的清單。

警告

從 Windows 8 和 Windows Server 2012 開始，不支援使用此函式來存取遠端計算機，因為此功能已移除。

Reserved

必須是 NULL。

傳回值

如果函式成功，函式會傳回 TRUE 。 否則，它會傳回 FALSE ，而且可以藉由呼叫 GetLastError 來擷取記錄的錯誤。 如果所需的大小大於 HwProfileListSize，SetupDiGetHwProfileListEx 會傳回 FALSE，而 GetLastError 的呼叫會傳回ERROR_INSUFFICIENT_BUFFER。

備註

注意

setupapi.h 標頭會根據 UNICODE 預處理器常數的定義，將 SetupDiGetHwProfileListEx 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求	值
最低支援的用戶端	可在 Microsoft Windows 2000 和更新版本的 Windows 中使用。
目標平台	桌面
標頭	setupapi.h (包括 Setupapi.h)
程式庫	Setupapi.lib

另請參閱

SetupDiGetHwProfileFriendlyNameEx