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

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

構文

EVT_SERCX2_PIO_TRANSMIT_CANCEL_READY_NOTIFICATION EvtSercx2PioTransmitCancelReadyNotification;

BOOLEAN EvtSercx2PioTransmitCancelReadyNotification(
  [in] SERCX2PIOTRANSMIT PioTransmit
)
{...}

パラメーター

[in] PioTransmit

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

戻り値

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

ドライバーが既に SerCx2PioTransmitReady を呼び出している場合、またはこのメソッドを呼び出す場合、この関数は FALSE を返します。

注釈

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

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

以前に有効にした準備完了通知を取り消すために、 EvtSerCx2PioTransmitCancelReadyNotification 関数は、通常、送信 FIFO がより多くのデータを受け入れる準備ができていることを示すシリアル コントローラーの割り込みを無効にします。 SerCx2 は 、EvtSerCx2PioTransmitEnableReadyNotification 関数の以前の呼び出しでこの割り込みを有効にしました。

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

例

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

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

EVT_SERCX2_PIO_TRANSMIT_CANCEL_READY_NOTIFICATION  MyPioTransmitCancelReadyNotification;

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

_Use_decl_annotations_
BOOLEAN
  MyPioTransmitCancelReadyNotification(
    SERCX2PIOTRANSMIT  PioTransmit
    )
  {...}

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

要件

こちらもご覧ください

EvtSerCx2PioTransmitEnableReadyNotification

SERCX2PIOTRANSMIT

SerCx2PioTransmitCreate

SerCx2PioTransmitReady