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

EvtSerCx2PioReceiveCancelReadyNotification イベント コールバック関数は、シリアル フレームワーク拡張機能 (SerCx2) のバージョン 2 によって呼び出され、EvtSerCx2PioReceiveEnableReadyNotification イベント コールバック関数の以前の呼び出しで SerCx2 が有効になっているという準備完了通知を取り消します。

構文

EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION EvtSercx2PioReceiveCancelReadyNotification;

BOOLEAN EvtSercx2PioReceiveCancelReadyNotification(
  [in] SERCX2PIORECEIVE PioReceive
)
{...}

パラメーター

[in] PioReceive

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

戻り値

準備完了通知が正常に無効になり、シリアル コントローラー ドライバーがこの通知によって SerCx2PioReceiveReady メソッドが呼び出されないことを保証できる場合、EvtSerCx2PioReceiveCancelReadyNotification 関数は TRUE を返します。 この関数は、ドライバーが SerCx2PioReceiveReady を既に呼び出している場合、またはこのメソッドを呼び出す場合に FALSE を返します。

注釈

シリアル コントローラー ドライバーでは、この関数を実装する必要があります。 ドライバーは、PIO 受信オブジェクトを作成する SerCx2PioReceiveCreate 呼び出しに関数を登録します。

関連付けられた読み取り要求がタイムアウトするか、準備完了通知が有効になっている間に取り消された場合、 SerCx2 は EvtSerCx2PioReceiveCancelReadyNotification 関数を呼び出して、保留中の通知を取り消します。 この呼び出しが FALSE を返す場合、SerCx2 はシリアル コントローラー ドライバーが SerCx2PioReceiveReady を呼び出す必要があります。この呼び出しが実装されている場合は、 SerCx2 が EvtSerCx2PioReceiveCleanupTransaction イベント コールバック関数を呼び出し、要求を完了した後にのみ実行されます。

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

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

例

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

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

EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION  MyPioReceiveCancelReadyNotification;

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

_Use_decl_annotations_
BOOLEAN
  MyPioReceiveCancelReadyNotification(
    SERCX2PIORECEIVE  PioReceive
    )
  {...}

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

要件

こちらもご覧ください

EvtSerCx2PioReceiveEnableReadyNotification

SERCX2PIORECEIVE

SerCx2PioReceiveCreate

SerCx2PioReceiveReady