MINIPORT_CANCEL_SEND コールバック関数 (ndis.h)

[アーティクル]
08/07/2023

NDIS は、ミニポートドライバーの MiniportCancelSend 関数を呼び出して、指定したキャンセル識別子でマークされているすべての NET_BUFFER_LIST 構造体の転送を取り消します。

メモMINIPORT_CANCEL_SEND型を使用して関数を宣言する必要があります。詳細については、次の例に関するセクションを参照してください。

構文

MINIPORT_CANCEL_SEND MiniportCancelSend;

void MiniportCancelSend(
  [in] NDIS_HANDLE MiniportAdapterContext,
  [in] PVOID CancelId
)
{...}

パラメーター

[in] MiniportAdapterContext

ミニポートドライバーがそのミニポート初期化Ex 関数で割り当てたコンテキスト領域へのハンドル。ミニポートドライバーは、アダプターに関する状態情報を維持するために、このコンテキスト領域を使用します。

[in] CancelId

キャンセル識別子。この識別子は、取り消される NET_BUFFER_LIST 構造体を指定します。

戻り値

なし

解説

ミニポートドライバーとキューが送信する中間ドライバー NET_BUFFER_LIST構造体 は、MiniportCancelSend 関数をエクスポートします。 MiniportCancelSend 関数は、指定したNET_BUFFER_LIST構造体の保留中の転送を取り消します。

上にある NDIS ドライバーがを呼び出すと、 NdisCancelSendNetBufferLists 関数は、NDIS は、バインディングの適切な下位レベルドライバーの MiniportCancelSend 関数を呼び出します。 NDIS は、下位レベルのドライバーが MiniportCancelSend 関数をエクスポートする場合にのみ、この呼び出しを行います。

ミニポートドライバーの MiniportCancelSend 関数は、次の操作を実行します。

指定したアダプターのキューに登録されたNET_BUFFER_LIST構造体の一覧を走査し、 NDIS_GET_NET_BUFFER_LIST_CANCEL_ID マクロを使用して、キューに登録されている各NET_BUFFER_LIST構造体のキャンセル識別子を取得します。ミニポートドライバーは、NDIS が MiniportCancelSend に渡したキャンセル識別子とNDIS_GET_NET_BUFFER_LIST_CANCEL_ID返すキャンセル識別子を比較します。
キャンセル識別子が指定したキャンセル識別子と一致するすべてのNET_BUFFER_LIST構造体を送信キューから削除します (リンク解除)。
を呼び出します。構造体を返すリンクされていないすべてのNET_BUFFER_LIST構造体の NdisMSendNetBufferListsComplete 関数。ミニポートドライバーは、NET_BUFFER_LIST構造体の状態フィールドをNDIS_STATUS_SEND_ABORTEDに設定します。

中間ドライバーの MiniportCancelSend 関数は、次の操作を実行します。

ミニポートドライバーの MiniportCancelSend 関数の前の一覧の操作を実行します。
を呼び出します。 NdisCancelSendNetBufferLists 関数。 MiniportCancelSend の呼び出しで NDIS が指定したアダプターにマップされるバインディングを指定します。

NDIS は、IRQL <= DISPATCH_LEVELで MiniportCancelSend を呼び出します。

例

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

たとえば、" MyCancelSend" という名前の MiniportCancelSend 関数を定義するには、次のコード例に示すように 、MINIPORT_CANCEL_SEND 型を使用します。

MINIPORT_CANCEL_SEND MyCancelSend;

次に、次のように関数を実装します。

_Use_decl_annotations_
VOID
 MyCancelSend(
    NDIS_HANDLE  MiniportAdapterContext,
    PVOID  CancelId
    )
  {...}

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

Use_decl_annotationsの詳細については、「関数の動作に注釈を付ける」を参照してください。

要件

要件	値
サポートされている最小のクライアント	NDIS 6.0 以降でサポートされています。
対象プラットフォーム	Windows
ヘッダー	ndis.h (Ndis.h を含む)
IRQL	<= DISPATCH_LEVEL