EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION コールバック関数 (sercx.h)
EvtSerCx2SystemDmaReceiveCleanupTransaction イベント コールバック関数は、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出され、システム DMA 受信トランザクションの終了後にシリアル コントローラーの状態をクリーンします。
構文
EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION EvtSercx2SystemDmaReceiveCleanupTransaction;
void EvtSercx2SystemDmaReceiveCleanupTransaction(
[in] SERCX2SYSTEMDMARECEIVE SystemDmaReceive
)
{...}
パラメーター
[in] SystemDmaReceive
system-DMA-receive オブジェクトへの SERCX2SYSTEMDMARECEIVE ハンドル。 このオブジェクトを作成するために 、以前に SerCx2SystemDmaReceiveCreate メソッドを呼び出したシリアル コントローラー ドライバー。
戻り値
なし
解説
シリアル コントローラー ドライバーでは、オプションとしてこの関数を実装できます。 実装されている場合、ドライバーは、システム DMA 受信オブジェクトを作成する SerCx2SystemDmaReceiveCreate 呼び出しに関数を登録します。
シリアル コントローラー ドライバーは、システム DMA 受信トランザクションの最後にシリアル コントローラーの状態をクリーンする必要がある場合は、EvtSerCx2SystemDmaReceiveCleanupTransaction 関数を実装する必要があります。 SerCx2 は、システム DMA 受信トランザクションが終了した後、実装されている場合は、この関数を呼び出します。 EvtSerCx2SystemDmaReceiveCleanupTransaction 呼び出しに応答して、シリアル コントローラー ドライバーは SerCx2SystemDmaReceiveCleanupTransactionComplete メソッドを呼び出して、クリーン作業が完了した後に SerCx2 に通知する必要があります。
詳細については、「 SerCx2 System-DMA-Receive Transactions」を参照してください。
例
EvtSerCx2SystemDmaReceiveCleanupTransaction コールバック関数を定義するには、まず、定義するコールバック関数の種類を識別する関数宣言を指定する必要があります。 Windows には、ドライバーのコールバック関数型のセットが用意されています。 コールバック関数の種類を使用して関数を宣言すると、 ドライバーのコード分析、 静的ドライバー検証ツール (SDV)、およびその他の検証ツールでエラーが検出され、Windows オペレーティング システムのドライバーを記述するための要件になります。
たとえば、 という名前MySystemDmaReceiveCleanupTransaction
の EvtSerCx2SystemDmaReceiveCleanupTransaction コールバック関数を定義するには、次のコード例に示すように、EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION関数型を使用します。
EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION MySystemDmaReceiveCleanupTransaction;
次に、コールバック関数を次のように実装します。
_Use_decl_annotations_
VOID
MySystemDmaReceiveCleanupTransaction(
SERCX2SYSTEMDMARECEIVE SystemDmaReceive
)
{...}
EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION関数の種類は、Sercx.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、 Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations注釈を使用すると、ヘッダー ファイル内のEVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「 KMDF ドライバーの関数ロール型を使用した関数の宣言」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 8.1 以降で使用できます。 |
対象プラットフォーム | デスクトップ |
Header | sercx.h |
IRQL | IRQL <= DISPATCH_LEVELで呼び出されます。 |