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 を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Microsoft Windows 2000 以降のバージョンの Windows で使用できます。 |
| 対象プラットフォーム | デスクトップ |
| Header | setupapi.h (Setupapi.h を含む) |
| Library | Setupapi.lib |