WdfDriverOpenParametersRegistryKey 関数 (wdfdriver.h)

[アーティクル]
03/05/2024

[KMDF と UMDF に適用]

WdfDriverOpenParametersRegistryKey メソッドは、ドライバーの Parameters レジストリキーを開き、キーを表すフレームワークレジストリキーオブジェクトへのハンドルを取得します。

構文

NTSTATUS WdfDriverOpenParametersRegistryKey(
  [in]           WDFDRIVER              Driver,
  [in]           ACCESS_MASK            DesiredAccess,
  [in, optional] PWDF_OBJECT_ATTRIBUTES KeyAttributes,
  [out]          WDFKEY                 *Key
);

パラメーター

[in] Driver

以前の WdfDriverCreate または WdfGetDriver の呼び出しからドライバーが取得したドライバーのフレームワークドライバーオブジェクトへのハンドル。

[in] DesiredAccess

Parameters レジストリキーのアクセスマスクを指定するACCESS_MASK型指定された値。

KMDF ドライバーは通常、 KEY_READ、 KEY_WRITE、またはKEY_READを要求します 。 |KEY_WRITE。

UMDF ドライバーを作成する場合は、 KEY_READ または KEY_READ を使用します。 |KEY_SET_VALUE。

ベストプラクティスとして、ドライバーに必要なアクセスの種類のみを要求します。

[in, optional] KeyAttributes

フレームワークレジストリキーオブジェクトのオブジェクト属性を指定する呼び出し元によって割り当てられた WDF_OBJECT_ATTRIBUTES 構造体へのポインター。このパラメーターは省略可能であり、WDF_NO_OBJECT_ATTRIBUTESできます。

[out] Key

フレームワークレジストリキーオブジェクトへのハンドルを受け取る場所へのポインター。

戻り値

操作が成功した場合、WdfDriverOpenParametersRegistryKey はSTATUS_SUCCESSを返します。その他の戻り値は次のとおりです。

リターンコード	説明
STATUS_ACCESS_DENIED	UMDF ドライバーは、DesiredAccess パラメーターに次のいずれかのフラグを指定しました。 GENERIC_WRITE KEY_CREATE_SUBKEY WRITE_DAC 上記の値は UMDF ドライバーでは無効であるため、GENERIC_ALL や STANDARD_RIGHTS_ALL などのユニバーサルフラグを指定すると、 WdfDriverOpenParametersRegistryKey もこの戻り値で失敗します。

リターンコード

説明

STATUS_ACCESS_DENIED

UMDF ドライバーは 、DesiredAccess パラメーターに次のいずれかのフラグを指定しました。

GENERIC_WRITE
KEY_CREATE_SUBKEY
WRITE_DAC

上記の値は UMDF ドライバーでは無効であるため、GENERIC_ALL や STANDARD_RIGHTS_ALL などのユニバーサルフラグを指定すると、 WdfDriverOpenParametersRegistryKey もこの戻り値で失敗します。

戻り値の詳細については、「フレームワークオブジェクト作成エラー」を参照してください。

このメソッドは、他の NTSTATUS 値も返す場合があります。

KMDF ドライバーがドライバーで無効なハンドルを指定した場合、システムバグチェックが発生します。

注釈

ドライバーの パラメーター キーは、レジストリのサービスツリーにあります。ドライバーの Parameters キーが存在しない場合は、 WdfDriverOpenParametersRegistryKey メソッドによって作成されます。

ドライバーが Parameters レジストリキーの使用を完了したら、ドライバーは WdfRegistryClose を呼び出す必要があります。

注意

UMDF では、サブキーの作成はサポートされていません。

レジストリの詳細については、「 Framework-Based ドライバーでのレジストリの使用」を参照してください。

例

次のコード例では、ドライバーの Parameters レジストリキーを開き、そのキーを表すフレームワークレジストリキーオブジェクトへのハンドルを取得します。

WDFKEY hKey;

status = WdfDriverOpenParametersRegistryKey(
                                            Driver,
                                            STANDARD_RIGHTS_ALL,
                                            WDF_NO_OBJECT_ATTRIBUTES,
                                            &hKey
                                            );

要件

要件	値
対象プラットフォーム	ユニバーサル
最小 KMDF バージョン	1.0
最小 UMDF バージョン	2.0
Header	wdfdriver.h (Wdf.h を含む)
Library	Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF)
IRQL	PASSIVE_LEVEL
DDI コンプライアンス規則	DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)