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

クラスの説明 (NULL ターミネータを含む) を格納するために必要なサイズを文字で受け取る DWORD 型の変数へのポインター。 RequiredSize は常にLINE_LEN未満です。 このパラメーターは省略可能であり、NULLできます。

戻り値

この関数は、成功した場合 TRUE を返します。 それ以外の場合は、FALSE を返し、ログに記録されたエラーを GetLastError呼び出して取得できます。

備考

SetupDiGetClassDescriptionEx 呼び出して、リモート コンピューターにインストールされているセットアップ クラスの説明を取得します。

手記

setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupDiGetClassDescription を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Microsoft Windows 2000 以降のバージョンの Windows で使用できます。
ターゲット プラットフォーム の	デスクトップ
ヘッダー	setupapi.h (Setupapi.h を含む)
ライブラリ	Setupapi.lib

関連項目

SetupDiBuildClassInfoList の

SetupDiGetClassDescriptionEx の

SetupDiGetINFClass の