EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CLEANUPコールバック関数 (sercx.h)
EvtSerCx2CustomTransmitTransactionCleanup イベント コールバック関数は、カスタム送信トランザクションの終了後にシリアル コントローラーのハードウェア状態をクリーンアップするために、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出されます。
構文
EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CLEANUP EvtSercx2CustomTransmitTransactionCleanup;
void EvtSercx2CustomTransmitTransactionCleanup(
[in] SERCX2CUSTOMTRANSMITTRANSACTION CustomTransmitTransaction
)
{...}
パラメーター
[in] CustomTransmitTransaction
カスタム送信オブジェクトへの SERCX2CUSTOMTRANSMITTRANSACTION ハンドル。 シリアル コントローラー ドライバーは、以前にこのオブジェクトを作成するために、SerCx2CustomTransmitTransactionCreate メソッドを呼び出しました。
戻り値
何一つ
備考
シリアル コントローラー ドライバーは、オプションとしてこの関数を実装できます。 実装されている場合、ドライバーは、カスタム送信オブジェクトを作成する SerCx2CustomTransmitTransactionCreate 呼び出しに関数を登録します。
シリアル コントローラー ドライバーは、カスタム送信トランザクションの最後にシリアル コントローラーの状態をクリーンアップする必要がある場合は、EvtSerCx2CustomTransmitTransactionCleanup 関数を実装する必要があります。 SerCx2 は、実装されている場合、カスタム送信トランザクションの終了後にこの関数を呼び出します。 EvtSerCx2CustomTransmitTransactionCleanup 呼び出しに応答して、シリアル コントローラー ドライバーは、クリーンアップ作業が完了した後に SerCx2 に通知する SerCx2CustomTransmitTransactionCleanupComplete メソッドを呼び出す必要があります。
詳細については、「SerCx2 Custom-Transmit Transactions」を参照してください。
例
EvtSerCx2CustomTransmitTransactionCleanup コールバック関数
たとえば、EvtSerCx2CustomTransmitTransactionCleanup コールバック関数 MyCustomTransmitTransactionCleanup
定義するには、次のコード例に示すように、EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CLEANUP 関数型を使用します。
EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CLEANUP MyCustomTransmitTransactionCleanup;
次に、次のようにコールバック関数を実装します。
_Use_decl_annotations_
VOID
MyCustomTransmitTransactionCleanup(
SERCX2CUSTOMTRANSMITTRANSACTION CustomTransmitTransaction
)
{...}
EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CLEANUP 関数型は、Sercx.h ヘッダー ファイルで定義されています。 コード分析ツールの実行時にエラーをより正確に識別するには、Use_decl_annotations 注釈を関数定義に追加してください。 Use_decl_annotations 注釈により、ヘッダー ファイル内の EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CLEANUP 関数型に適用される注釈が確実に使用されます。 関数宣言の要件の詳細については、「KMDF ドライバーの関数ロール型を使用して関数を宣言する」を参照してください。 Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。
必要条件
要件 | 価値 |
---|---|
サポートされる最小クライアント | Windows 8.1以降で使用できます。 |
ターゲット プラットフォーム の |
デスクトップ |
ヘッダー | sercx.h |
IRQL | IRQL <= DISPATCH_LEVEL で呼び出されます。 |
関連項目
SERCX2CUSTOMTRANSMITTRANSACTION
SerCx2CustomTransmitTransactionCleanupComplete の
SerCx2CustomTransmitTransactionCreate の