RTL_RUN_ONCE_INIT_FN コールバック関数 (ntddk.h)

[アーティクル]
02/07/2025

RunOnceInitialization ルーチンは、1 回限りの初期化操作を実行します。

構文

ULONG /* LOGICAL */
NTAPI
RTL_RUN_ONCE_INIT_FN (
    _Inout_ PRTL_RUN_ONCE RunOnce,
    _Inout_opt_ PVOID Parameter,
    _Inout_opt_ PVOID *Context
  );

typedef RTL_RUN_ONCE_INIT_FN *PRTL_RUN_ONCE_INIT_FN;

パラメーター

[in, out] RunOnce

この RunOnceInitialization ルーチンを呼び出した、RtlRunOnceExecuteOnce ルーチンに、ドライバーが以前にパラメーターとして渡した RTL_RUN_ONCE 1 回限りの初期化構造体へのポインター。

[in, out] Parameter

パラメーターは、この RunOnceInitialization ルーチンを呼び出した RtlRunOnceExecuteOnce ルーチンにドライバーが渡した値を します。

[out] Context

ルーチンが初期化データを書き込む PVOID 変数へのポインター。

戻り値

RunOnceInitialization ルーチンは、成功を示す 0 以外の値を返し、失敗を示す 0 を返します。

備考

ドライバー実装 RunOnceInitialization ルーチンは、ドライバー固有の初期化を実行し、コンテキスト パラメーターが指すメモリの場所に初期化データを書き込みます。ドライバーは、RtlRunOnceExecuteOnce ルーチンを使用して、RunOnceInitialization ルーチンを 1 回限り呼び出します。オペレーティングシステムは、RunOnceInitialization ルーチンが、RunOnce パラメーターの同じ値に対して 2 回呼び出されないことを保証します。

Context パラメーターが指す場所にある少数の下位ビットは、オペレーティングシステムで使用するために予約されています。ドライバーの RunOnceInitialization ルーチンは、*Contextに書き込む出力値で、これらの予約済みビットをゼロに設定する必要があります。 Ntddk.h で定義されているRTL_RUN_ONCE_CTX_RESERVED_BITS定数は、予約されている下位ビットの数を指定します。現在、RTL_RUN_ONCE_CTX_RESERVED_BITSは 2 として定義されています。つまり、ドライバーは、コンテキスト が指す PVOID 値の下位 2 ビット ゼロに設定する必要があります。

例

RunOnceInitialization コールバックルーチンを定義するには、まず、定義するコールバックルーチンの種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。コールバック関数の種類を使用して関数を宣言すると、ドライバーのコード分析、静的ドライバー検証ツール (SDV)、およびその他の検証ツールをすると、エラーが検出され、Windows オペレーティングシステムのドライバーを記述するための要件になります。

たとえば、MyRunOnceInitializationという名前の RunOnceInitialization コールバックルーチンを定義するには、次のコード例に示すようにRTL_RUN_ONCE_INIT_FN型を使用します。

RTL_RUN_ONCE_INIT_FN MyRunOnceInitialization;

次に、次のようにコールバックルーチンを実装します。

_Use_decl_annotations_
ULONG 
  MyRunOnceInitialization(
    PRTL_RUN_ONCE  RunOnce,
    PVOID  Parameter,
    PVOID  *Context
    )
  {
      // Function body
  }

RTL_RUN_ONCE_INIT_FN関数の種類は、Wdm.h ヘッダーファイルで定義されています。コード分析ツールの実行時にエラーをより正確に識別するには、_Use_decl_annotations_ 注釈を関数定義に追加してください。 _Use_decl_annotations_ 注釈により、ヘッダーファイル内のRTL_RUN_ONCE_INIT_FN関数型に適用される注釈が確実に使用されます。関数宣言の要件の詳細については、「WDM ドライバーのの関数の役割の種類を使用して関数を宣言するを参照してください。 _Use_decl_annotations_の詳細については、「関数の動作に注釈を付けるを参照してください。

必要条件

要件	価値
サポートされる最小クライアント	ドライバーは、Windows Vista 以降のバージョンの Windows でのみ、RunOnceInitialization ルーチンを実装できます。
ターゲットプラットフォームの	デスクトップ
ヘッダー	ntddk.h (Ntddk.h、Ntifs.h を含む)
IRQL	IRQL <= APC_LEVEL で呼び出されます。

次の方法で共有

RTL_RUN_ONCE_INIT_FN コールバック関数 (ntddk.h)

構文

パラメーター

戻り値

備考

例

必要条件

関連項目

フィードバック

その他のリソース