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

EvtSerCx2SystemDmaReceiveCancelNewDataNotification イベント コールバック関数は、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出され、イベント コールバック関数 EvtSerCx2SystemDmaReceiveEnableNewDataNotification への以前の呼び出しで SerCx2 が有効になった新しいデータ通知を取り消します。

構文

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION EvtSercx2SystemDmaReceiveCancelNewDataNotification;

BOOLEAN EvtSercx2SystemDmaReceiveCancelNewDataNotification(
  [in] SERCX2SYSTEMDMARECEIVE SystemDmaReceive
)
{...}

パラメーター

[in] SystemDmaReceive

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

戻り値

EvtSerCx2SystemDmaReceiveCancelNewDataNotification 関数は、新しいデータ通知が正常に取り消され、シリアル コントローラー ドライバーが SerCx2SystemDmaReceiveNewDataNotification メソッドを呼び出さないことを保証できる場合、true を 返します。 この関数は、ドライバーが既に SerCx2SystemDmaReceiveNewDataNotification メソッドを呼び出している場合、またはこのメソッドを呼び出しようとしている場合に、FALSE を返します。

備考

シリアル コントローラー ドライバーは、オプションとしてこの関数を実装できます。 実装されている場合、ドライバーは、システム DMA 受信オブジェクトを作成する SerCx2SystemDmaReceiveCreate 呼び出しに関数を登録します。 この関数を実装するドライバーは、イベント コールバック関数 EvtSerCx2SystemDmaReceiveEnableNewDataNotification 実装する必要もあります。

関連付けられた読み取り要求がタイムアウトになった場合、または新しいデータ通知要求が保留中の間に取り消された場合、SerCx2 は EvtSerCx2SystemDmaReceiveCancelNewDataNotification 関数を呼び出して、保留中の通知を取り消します。 この呼び出しから FALSE返された場合、SerCx2 はシリアル コントローラー ドライバーが SerCx2SystemDmaReceiveNewDataNotification呼び出すと想定します。この呼び出しの後でのみ、SerCx2 は、実装されている場合は、EvtSerCx2SystemDmaReceiveCleanupTransaction 関数を呼び出し、要求を完了します。

新しいデータ通知を取り消すために、EvtSerCx2SystemDmaReceiveCancelNewDataNotification 関数は、通常、受信 FIFO から読み取ることができるデータが増えるかどうかを示すシリアル コントローラーの割り込みを無効にします。 この割り込みは、EvtSerCx2SystemDmaReceiveEnableNewDataNotification 関数への以前の呼び出しによって有効にされました。

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

例

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

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

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION  MySystemDmaReceiveCancelNewDataNotification;

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

_Use_decl_annotations_
BOOLEAN
  MySystemDmaReceiveCancelNewDataNotification(
    SERCX2SYSTEMDMARECEIVE  SystemDmaReceive
    )
  {...}

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

必要条件

関連項目

EvtSerCx2SystemDmaReceiveEnableNewDataNotification の

SERCX2SYSTEMDMARECEIVE

SerCx2SystemDmaReceiveCreate の

SerCx2SystemDmaReceiveNewDataNotification の