SetupDiGetClassDescriptionA 函式 (setupapi.h)

  • 發行項

SetupDiGetClassDescription函式會擷取與指定之安裝類別 GUID 相關聯的類別描述。

語法

WINSETUPAPI BOOL SetupDiGetClassDescriptionA(
  [in]            const GUID *ClassGuid,
  [out]           PSTR       ClassDescription,
  [in]            DWORD      ClassDescriptionSize,
  [out, optional] PDWORD     RequiredSize
);

參數

[in] ClassGuid

要擷取其描述之安裝類別的 GUID。

[out] ClassDescription

接收類別描述之字元緩衝區的指標。

[in] ClassDescriptionSize

ClassDescription緩衝區的大小，以字元為單位。

[out, optional] RequiredSize

DWORD 類型的變數指標，其接收大小，以字元為單位，必須儲存類別描述， (包括 Null 結束字元) 。 RequiredSize 一律小於 LINE_LEN。 這個參數是選擇性的，而且可以是 Null。

傳回值

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

備註

呼叫 SetupDiGetClassDescriptionEx 以擷取安裝在遠端電腦上的安裝類別描述。

注意

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

規格需求

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

另請參閱

SetupDiBuildClassInfoList

SetupDiGetClassDescriptionEx

SetupDiGetINFClass