SetupDiGetClassPropertyExW 関数 (setupapi.h)

[アーティクル]
03/15/2023

SetupDiGetClassPropertyEx 関数は、ローカルコンピューターまたはリモートコンピューター上のデバイスセットアップクラスまたはデバイスインターフェイスクラスのクラスプロパティを取得します。

構文

WINSETUPAPI BOOL SetupDiGetClassPropertyExW(
  [in]            const GUID       *ClassGuid,
  [in]            const DEVPROPKEY *PropertyKey,
  [out]           DEVPROPTYPE      *PropertyType,
  [out, optional] PBYTE            PropertyBuffer,
  [in]            DWORD            PropertyBufferSize,
  [out, optional] PDWORD           RequiredSize,
  [in]            DWORD            Flags,
  [in, optional]  PCWSTR           MachineName,
                  PVOID            Reserved
);

パラメーター

[in] ClassGuid

デバイスクラスのデバイスプロパティを取得するデバイスセットアップクラスまたはデバイスインターフェイスクラスを識別する GUID へのポインター。クラス型の指定については、 Flags パラメーターに関するページを参照してください。

[in] PropertyKey

要求されたデバイスクラスプロパティのデバイスプロパティキーを表す DEVPROPKEY 構造体へのポインター。

[out] PropertyType

要求されたデバイスクラスプロパティのプロパティデータ型識別子を受け取る DEVPROPTYPE 型の変数へのポインター。ここで、プロパティデータ型識別子は基本データ型識別子間のビットごとの OR であり、基本データ型が変更された場合はプロパティデータ型修飾子です。

[out, optional] PropertyBuffer

要求されたデバイスクラスプロパティを受け取るバッファーへのポインター。 SetupDiGetClassPropertyEx は、バッファーがすべてのプロパティ値データを保持するのに十分な大きさの場合にのみ、要求されたプロパティ値を取得します。ポインターには NULL を指定できます。ポインターが NULL に設定され、 RequiredSize が指定されている場合、 SetupDiGetClassPropertyEx は*RequiredSize のデバイスクラスプロパティのサイズをバイト単位で返します。

[in] PropertyBufferSize

PropertyBuffer バッファーのサイズ (バイト単位)。 PropertyBuffer が NULL に設定されている場合は、PropertyBufferSize を 0 に設定する必要があります。

[out, optional] RequiredSize

プロパティが取得された場合はデバイスクラスプロパティのサイズ (バイト単位) を受け取る DWORD 型の変数へのポインター。バッファーが十分な大きさでない場合は必要なバッファーサイズ。このポインターは NULL に設定できます。

[in] Flags

クラスがデバイスセットアップクラスかデバイスインターフェイスクラスかを指定する、次のいずれかの値です。

DICLASSPROP_INSTALLER

ClassGuid は 、デバイスセットアップクラスを指定します。このフラグは、DICLASSPROP_INTERFACEでは使用できません。

DICLASSPROP_INTERFACE

ClassGuid は 、デバイスインターフェイスクラスを指定します。このフラグは、DICLASSPROP_INSTALLERでは使用できません。

[in, optional] MachineName

コンピューターの "\" プレフィックスを含む UNC 名を含む NULL で終わる文字列へのポインター。ポインターは NULL に設定できます。 MachineName が NULL の場合、SetupDiGetClassPropertyEx は要求されたデバイスクラスプロパティをローカルコンピューターから取得します。

注意事項

この機能は削除されたため、この関数を使用してリモートマシンにアクセスすることは、Windows 8 および Windows Server 2012 以降ではサポートされていません。

Reserved

このパラメーターは NULL に設定する必要があります。

戻り値

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

次の表には、この関数がログに記録する可能性がある一般的なエラーコードの一部が含まれています。

リターンコード	説明
ERROR_INVALID_FLAGS	Flags の値は 0 ではありません。
ERROR_INVALID_CLASS	ClassGuid で指定されたデバイスセットアップクラスが無効です。このエラーは、DICLASSPROP_INSTALLER フラグが指定されている場合にのみ発生します。
ERROR_INVALID_PARAMETER	指定されていないパラメーターが無効です。
ERROR_INVALID_REG_PROPERTY	PropertyKey によって提供されるプロパティキーが無効です。
ERROR_INVALID_REFERENCE_STRING	デバイスインターフェイス参照文字列が無効です。このエラーは、DICLASSPROP_INTERFACE フラグが指定されている場合に返すことができます。
ERROR_INVALID_DATA	指定されていない内部データ値が無効でした。
ERROR_INVALID_USER_BUFFER	ユーザーバッファーが無効です。 1 つの可能性は、 PropertyBuffer が NULL で、 PropertyBufferSize が 0 ではないことです。
ERROR_INVALID_MACHINENAME	MachineName で指定されたコンピューター名が無効です。
ERROR_NO_SUCH_INTERFACE_CLASS	ClassGuid で指定されたデバイスインターフェイスクラスが存在しません。このエラーは、DICLASSPROP_INTERFACE フラグが指定されている場合にのみ発生します。
ERROR_INSUFFICIENT_BUFFER	システム呼び出しに渡された内部データバッファーが小さすぎます。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するのに十分なシステムメモリが不足していました。
ERROR_NOT_FOUND	要求されたデバイスプロパティが存在しません。
ERROR_ACCESS_DENIED	呼び出し元には管理者特権がありません。

注釈

SetupDiGetClassPropertyEx は、統合デバイスプロパティモデルの一部です。

SetupAPI では、 SetupDiGetClassPropertyEx の Unicode バージョンのみがサポートされます。

デバイスインターフェイスプロパティを設定するには、 SetupDiGetClassPropertyEx の呼び出し元が Administrators グループのメンバーである必要があります。

リモートコンピューター上のデバイスクラスに設定されているデバイスプロパティを表すデバイスプロパティキーを取得するには、 SetupDiGetClassPropertyKeysEx を呼び出します。

ローカルコンピューターでデバイスクラスプロパティを取得するには、 SetupDiGetClassProperty を呼び出します。

ローカルコンピューターでデバイスクラスプロパティを設定するには、SetupDiSetClassProperty を呼び出し、リモートコンピューターでデバイスクラスプロパティを設定するには、SetupDiSetClassPropertyEx を呼び出します。

要件

要件	値
サポートされている最小のクライアント	Windows Vista 以降のバージョンの Windows で使用できます。
対象プラットフォーム	Desktopユニバーサルの場合は、CM_Get_Class_Property_ExWを呼び出します
Header	setupapi.h (Setupapi.h を含む)
Library	Setupapi.lib