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

要求された NULL 終端クラスの説明を格納するために必要なサイズを文字で受け取る DWORD 型の変数へのポインター。 このポインターは省略可能であり、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 プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupDiGetClassDescriptionEx を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

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

関連項目

SetupDiBuildClassInfoList の

SetupDiBuildClassInfoListEx の

SetupDiGetDeviceInfoListDetail の

SetupDiGetINFClass の