EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION コールバック関数 (sercx.h)

  • [アーティクル]

EvtSerCx2PioReceiveCleanupTransaction イベント コールバック関数は、PIO 受信トランザクションの終了後にシリアル コントローラーのハードウェア状態をクリーンアップするために、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出されます。

構文

EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION EvtSercx2PioReceiveCleanupTransaction;

void EvtSercx2PioReceiveCleanupTransaction(
  [in] SERCX2PIORECEIVE PioReceive
)
{...}

パラメーター

[in] PioReceive

PIO 受信オブジェクトへの SERCX2PIORECEIVE ハンドル。 シリアル コントローラー ドライバーは、以前にこのオブジェクトを作成するために、SerCx2PioReceiveCreate メソッドを呼び出しました。

戻り値

何一つ

備考

シリアル コントローラー ドライバーは、オプションとしてこの関数を実装できます。 実装されている場合、ドライバーは、PIO 受信オブジェクトを作成する SerCx2PioReceiveCreate メソッドの呼び出しで関数を登録します。

シリアル コントローラー ドライバーは、PIO 受信トランザクションの最後にシリアル コントローラーの状態をクリーンアップする必要がある場合は、EvtSerCx2PioReceiveCleanupTransaction 関数を実装する必要があります。 SerCx2 は、実装されている場合、PIO 受信トランザクションの終了後にこの関数を呼び出します。 EvtSerCx2PioReceiveCleanupTransaction 呼び出し に応答して、シリアル コントローラー ドライバーは、クリーンアップ作業が完了した後に SerCx2 に通知する SerCx2PioReceiveCleanupTransactionComplete メソッドを呼び出す必要があります。

詳細については、「SerCx2 PIO-Receive Transactions」を参照してください。

例

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

たとえば、MyPioReceiveCleanupTransactionという名前のコールバック関数 EvtSerCx2PioReceiveCleanupTransaction を定義するには、次のコード例に示すように、EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION 関数型を使用します。

EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION  MyPioReceiveCleanupTransaction;

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

_Use_decl_annotations_
VOID
  MyPioReceiveCleanupTransaction(
    SERCX2PIORECEIVE  PioReceive
    )
  {...}

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

必要条件

要件 価値
サポートされる最小クライアント Windows 8.1以降で使用できます。
ターゲット プラットフォーム の デスクトップ
ヘッダー sercx.h
IRQL IRQL <= DISPATCH_LEVEL で呼び出されます。

関連項目

SERCX2PIORECEIVE

SerCx2PioReceiveCleanupTransactionComplete

SerCx2PioReceiveCreate