次の方法で共有

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 メソッドを呼び出しました。

戻り値

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

備考

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

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

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

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

例

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

たとえば、という名前のコールバック関数 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の詳細については、「関数の動作に注釈を付ける」を参照してください。

必要条件

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

関連項目

EvtSerCx2PioReceiveEnableReadyNotification

SERCX2PIORECEIVE

SerCx2PioReceiveCreate

SerCx2PioReceiveReady