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 で使用できます。 |
| 対象プラットフォーム | デスクトップ |
| Header | setupapi.h (Setupapi.h を含む) |
| Library | Setupapi.lib |