EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE コールバック関数 (sercx.h)
EvtSerCx2CustomReceiveTransactionInitialize イベント コールバック関数は、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出され、新しいカスタム受信トランザクションを実行するようにシリアル コントローラー ハードウェアを準備します。
構文
EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE EvtSercx2CustomReceiveTransactionInitialize;
void EvtSercx2CustomReceiveTransactionInitialize(
[in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction,
[in] PMDL Mdl,
[in] ULONG Offset,
[in] ULONG Length
)
{...}
パラメーター
[in] CustomReceiveTransaction
カスタム受信トランザクション オブジェクトへの SERCX2CUSTOMRECEIVETRANSACTION ハンドル。 シリアル コントローラー ドライバーは、以前にこのオブジェクトを作成するために、SerCx2CustomReceiveTransactionCreate メソッドを呼び出しました。
[in] Mdl
カスタム受信トランザクションの読み取りバッファーによってまたがっているメモリ ページを記述する MDL へのポインター。 DMA 転送の散布図/収集リストでは、Offset および Length パラメーターで指定されたこのメモリの領域が使用されます。
[in] Offset
データ転送の開始オフセット。 このパラメーターは、MDL によって記述されたバッファー領域の先頭からのバイト オフセットです。 MDL でバッファー領域の合計 N バイトが指定されている場合、Offset の使用可能な値は 0 から N から 1 の範囲になります。
[in] Length
データ転送のサイズ (バイト単位)。 MDL でバッファー領域の N バイトの合計が指定されている場合、Length の使用可能な値は、1 ~ N –オフセットの範囲になります。
戻り値
何一つ
備考
シリアル コントローラー ドライバーは、オプションとしてこの関数を実装できます。 実装されている場合、ドライバーは、カスタム受信オブジェクトを作成する SerCx2CustomReceiveTransactionCreate 呼び出しに関数を登録します。
ドライバーは、新しいカスタム受信トランザクションの準備としてシリアル コントローラーと関連ハードウェアを初期化する必要がある場合は、EvtSerCx2CustomReceiveTransactionInitialize 関数を実装する必要があります。 SerCx2 は、実装されている場合は、カスタム受信トランザクションを開始する前に、この関数を呼び出します。 この呼び出しに応答して、シリアル コント ローラー ドライバーは、初期化の完了後に SerCx2 に通知する SerCx2CustomReceiveTransactionInitializeComplete メソッドを呼び出す必要があります。
詳細については、「SerCx2 Custom-Receive Transactions」を参照してください。
例
EvtSerCx2CustomReceiveTransactionInitialize コールバック関数を定義するには、まず、定義するコールバック関数の型を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数の種類のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、ドライバーのコード分析、
たとえば、EvtSerCx2CustomReceiveTransactionInitialize MyCustomReceiveTransactionInitialize
という名前のコールバック関数 定義するには、次のコード例に示すように、EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE 関数型を使用します。
EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE MyCustomReceiveTransactionInitialize;
次に、次のようにコールバック関数を実装します。
_Use_decl_annotations_
VOID
MyCustomReceiveTransactionInitialize(
SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction,
WDFREQUEST Request,
PMDL Mdl,
ULONG Offset,
ULONG Length
)
{...}
EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE 関数の種類は、Sercx.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations 注釈により、ヘッダー ファイル内の EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE 関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「KMDF ドライバーの関数ロール型を使用して関数を宣言する」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows 8.1以降で使用できます。 |
ターゲット プラットフォーム の |
デスクトップ |
ヘッダー | sercx.h |
IRQL | IRQL <= DISPATCH_LEVEL で呼び出されます。 |
関連項目
MDL を
SERCX2CUSTOMRECEIVETRANSACTION