SetupDiSetClassPropertyExW 関数 (setupapi.h)

[アーティクル]
08/26/2023

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

構文

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

パラメーター

[in] ClassGuid

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

[in] PropertyKey

設定するデバイスクラスプロパティのデバイスプロパティキーを表す DEVPROPKEY 構造体へのポインター。

[in] PropertyType

クラスプロパティの property-data-type 識別子を表す DEVPROPTYPE 型の値。プロパティデータ型識別子の詳細については、このトピックで後述する 「解説 」セクションを参照してください。

[in, optional] PropertyBuffer

クラスプロパティ値を含むバッファーへのポインター。プロパティまたはプロパティ値を削除する場合は、このポインターを NULL に設定し、 PropertyBufferSize を 0 に設定する必要があります。プロパティ値の要件の詳細については、このトピックで後述する 「解説 」セクションを参照してください。

[in] PropertyBufferSize

PropertyBuffer バッファーのサイズ (バイト単位)。プロパティバッファーのサイズは、 PropertyType によって提供される property-data-type 識別子と一致している必要があります。 PropertyBuffer が NULL に設定されている場合は、PropertyBufferSize を 0 に設定する必要があります。

[in] Flags

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

DICLASSPROP_INSTALLER

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

DICLASSPROP_INTERFACE

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

[in, optional] MachineName

コンピューターの "\" プレフィックスを含む UNC 名を含む NULL で終わる Unicode 文字列へのポインター。このポインターは NULL に設定できます。ポインターが NULL の場合、 SetupDiSetClassPropertyEx はローカルコンピューターにインストールされているクラスのクラスプロパティを設定します。

注意事項

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

Reserved

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

戻り値

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

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

リターンコード	説明
ERROR_INVALID_FLAGS	Flags の値が無効です。
ERROR_INVALID_CLASS	ClassGuid で指定されたデバイスセットアップクラスが無効です。このエラーは、DICLASSPROP_INSTALLER フラグが指定されている場合にのみ発生します。
ERROR_INVALID_REFERENCE_STRING	デバイスインターフェイス参照文字列が無効です。このエラーは、DICLASSPROP_INTERFACE フラグが指定されている場合にのみ発生します。
ERROR_INVALID_REG_PROPERTY	PropertyKey によって提供されるプロパティキーが無効です。
ERROR_INVALID_DATA	指定されていない内部データ値が無効でした。 ClassGuid 値が有効な GUID ではない場合、またはプロパティ値が PropertyType で指定されたプロパティの種類と一致しない場合、このエラーがログに記録される可能性があります。
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	指定されていない項目が見つかりませんでした。 1 つの可能性は、削除するプロパティが存在しないことです。
ERROR_ACCESS_DENIED	呼び出し元には管理者特権がありません。

注釈

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

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

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

SetupDiSetClassPropertyEx は、property-data-type 識別子とプロパティ値に要件を適用します。

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

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

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

要件

要件	値
サポートされている最小のクライアント	Windows Vista 以降のバージョンの Windows で使用できます。
対象プラットフォーム	デスクトップ
Header	setupapi.h (Setupapi.h を含む)
Library	Setupapi.lib