SetupDiGetClassDescriptionExA 函式 (setupapi.h)
SetupDiGetClassDescriptionEx 函式會擷取安裝在本機或遠端電腦上的安裝類別描述。
語法
WINSETUPAPI BOOL SetupDiGetClassDescriptionExA(
[in] const GUID *ClassGuid,
[out] PSTR ClassDescription,
[in] DWORD ClassDescriptionSize,
[out, optional] PDWORD RequiredSize,
[in, optional] PCSTR MachineName,
PVOID Reserved
);
參數
[in] ClassGuid
要擷取其描述之安裝類別之 GUID 的指標。
[out] ClassDescription
接收類別描述之字元緩衝區的指標。
[in] ClassDescriptionSize
ClassDescription 參數所指向緩衝區的大小，以字元為單位。 NULL 終止類別描述的最大長度，以字元為單位，LINE_LEN。 如需詳細資訊，請參閱下列一節。
[out, optional] RequiredSize
DWORD 型別變數的指標，接收大小，以字元為單位，這是儲存所要求 NULL 終止類別描述的必要專案。 此指標是選擇性的，而且可以是 NULL。
[in, optional] MachineName
NULL 終止字串的指標，提供安裝類別所在遠端電腦的名稱。 此指標是選擇性的，而且可以是 NULL。 如果類別安裝在本機計算機上，請將指標設定為 NULL。
警告
從 Windows 8 和 Windows Server 2012 開始，不支援使用此函式來存取遠端計算機，因為此功能已移除。
Reserved
保留供系統使用。 此函式的呼叫端必須將此參數設定為 NULL。
傳回值
如果函式成功，函式會傳回 TRUE 。 否則，它會傳回 FALSE ，而且可以使用 呼叫 GetLastError 來擷取記錄的錯誤。
備註
如果類別的登錄機碼中有易記名稱，這個例程會傳回易記名稱。 否則，這個例程會傳回類別名稱。
SetupDiGetClassDescriptionEx 不會對可傳回的類別描述長度強制執行限制。 此函式會傳回 NULL 終止類別描述所需的大小，即使大於LINE_LEN也一樣。 不過，LINE_LEN是有效 NULL 終止類別描述的最大長度。 呼叫端絕對不需要大於LINE_LEN的緩衝區。
注意
setupapi.h 標頭會將 SetupDiGetClassDescriptionEx 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。
規格需求
| 需求 | 值 |
|---|---|
| 最低支援的用戶端 | 可在 Microsoft Windows 2000 和更新版本的 Windows 中使用。 |
| 目標平台 | 桌面 |
| 標頭 | setupapi.h (包括 Setupapi.h) |
| 程式庫 | Setupapi.lib |