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 標頭會根據 UNICODE 預處理器常數的定義,將 SetupDiGetClassDescriptionEx 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Microsoft Windows 2000 和更新版本的 Windows 中提供。 |
目標平臺 | 桌面 |
標頭 | setupapi.h (包括 Setupapi.h) |
連結庫 | Setupapi.lib |