SetupDiGetClassImageListExA 函式 (setupapi.h)

  • 發行項

SetupDiGetClassImageListEx 函式會針對安裝在本機或遠端系統上的每個類別，建置位圖的影像清單。

語法

WINSETUPAPI BOOL SetupDiGetClassImageListExA(
  [out]          PSP_CLASSIMAGELIST_DATA ClassImageListData,
  [in, optional] PCSTR                   MachineName,
                 PVOID                   Reserved
);

參數

[out] ClassImageListData

要接收類別影像清單相關信息之 SP_CLASSIMAGELIST_DATA 結構的指標，包括影像清單的句柄。 此結構的 cbSize 字段必須以結構的大小初始化，以位元組為單位，再呼叫此函式，否則將會失敗。

[in, optional] MachineName

NULL 終止字串的指標，其類別 SetupDiGetClassImageListEx 必須建置 點陣圖的遠端系統名稱。 這個參數是選擇性的，而且可以是 NULL。 如果 MachineName 為 NULL，SetupDiGetClassImageListEx 會建置本機系統的清單。

警告

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

Reserved

必須是 NULL。

傳回值

如果函式成功，函式會傳回 TRUE 。 否則，它會傳回 FALSE ，而且可以透過 呼叫 GetLastError 來擷取記錄的錯誤。

備註

呼叫 SetupDiDestroyClassImageList，應該終結此函式所建置的映射清單。

注意 只有在本機計算機上也存在類別時，才能顯示遠端電腦上的類別特定圖示。 因此，如果遠端計算機有 類別 X，但類別 X 未安裝在本機，則會傳回泛型 (未知) 圖示。
 

注意

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

規格需求

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

另請參閱

SetupDiDestroyClassImageList

SetupDiGetClassImageList