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

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

構文

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_CLEANUP EvtSercx2CustomReceiveTransactionCleanup;

void EvtSercx2CustomReceiveTransactionCleanup(
  [in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction
)
{...}

パラメーター

[in] CustomReceiveTransaction

カスタム受信トランザクション オブジェクトへの SERCX2CUSTOMRECEIVETRANSACTION ハンドル。 シリアル コントローラー ドライバーは、以前に SerCx2CustomReceiveTransactionCreate メソッドを呼び出して、このオブジェクトを作成しました。

戻り値

なし

解説

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

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

詳細については、「 SerCx2 Custom-Receive トランザクション」を参照してください。

例

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

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

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_CLEANUP  MyCustomReceiveTransactionCleanup;

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

_Use_decl_annotations_
VOID
  MyCustomReceiveTransactionCleanup(
    SERCX2CUSTOMRECEIVETRANSACTION  CustomReceiveTransaction
    )
  {...}

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

要件

こちらもご覧ください

SERCX2CUSTOMRECEIVETRANSACTION

SerCx2CustomReceiveTransactionCleanupComplete

SerCx2CustomReceiveTransactionCreate