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

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

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

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

構文

FILTER_CANCEL_SEND_NET_BUFFER_LISTS FilterCancelSendNetBufferLists;

void FilterCancelSendNetBufferLists(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PVOID CancelId
)
{...}

パラメーター

[in] FilterModuleContext

FilterAttach 関数でフィルタードライバーが割り当てたコンテキスト領域へのハンドル。フィルタードライバーは、このコンテキスト領域を使用して、フィルターモジュールの状態情報を維持します。

[in] CancelId

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

戻り値

なし

解説

FilterCancelSendNetBufferLists 関数は省略可能です。フィルタードライバーが送信要求をフィルター処理しない場合は、を呼び出すときに、この関数のエントリポイントを NULL に設定できます。 NdisFRegisterFilterDriver 関数。

送信前に構造体NET_BUFFER_LIST キューに入るフィルタードライバーは 、FilterCancelSendNetBufferLists 関数をエクスポートする 必要があります。 FilterCancelSendNetBufferLists 関数は、指定したNET_BUFFER_LIST構造体の保留中の転送を取り消します。

上にある NDIS ドライバーがを呼び出すと、 NdisCancelSendNetBufferLists または NdisFCancelSendNetBufferLists 関数は、バインドのフィルターモジュールの FilterCancelSendNetBufferLists 関数を呼び出します。

フィルタードライバーの FilterCancelSendNetBufferLists 関数は 、次の操作を実行します。

指定したフィルターモジュールのキューに登録されたNET_BUFFER_LIST構造体の一覧を走査し、 NDIS_GET_NET_BUFFER_LIST_CANCEL_ID マクロを使用して、キューに入った各NET_BUFFER_LIST構造体の取り消し識別子を取得します。フィルタードライバーは、ndis が FilterCancelSendNetBufferLists に渡したキャンセル ID とNDIS_GET_NET_BUFFER_LIST_CANCEL_ID返されるキャンセル ID を比較します。
キャンセル識別子が指定されたキャンセル識別子と一致するすべての NET_BUFFER_LIST 構造体を送信キューから削除 (リンク解除) します。
を呼び出します。構造体を返すリンクされていないすべてのNET_BUFFER_LIST構造体の NdisFSendNetBufferListsComplete 関数。フィルタードライバーは、NET_BUFFER_LIST構造体の状態フィールドをNDIS_STATUS_SEND_ABORTEDに設定します。
NdisFCancelSendNetBufferLists 関数を呼び出して、基になるドライバーにキャンセル送信要求を渡します。

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

例

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

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

FILTER_CANCEL_SEND_NET_BUFFER_LISTS MyCancelSendNetBufferLists;

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

_Use_decl_annotations_
VOID
 MyCancelSendNetBufferLists(
    NDIS_HANDLE  FilterModuleContext,
    PVOID  CancelId
    )
  {...}

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

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

要件

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