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

PacketDirect (PD) プラットフォームは、PD 対応ミニポート ドライバーの PDFlushQueue 関数を呼び出して、指定されたキューをフラッシュし、キュー内の完全な状態になっていない項目が間もなく完了するようにします。

構文

NDIS_PD_FLUSH_QUEUE NdisPdFlushQueue;

VOID() NdisPdFlushQueue(
  [in, out] NDIS_PD_QUEUE *Queue
)
{...}

パラメーター

[in, out] Queue

フラッシュするキュー。 詳細については、NDIS_PD_QUEUE構造に 関 するページを参照してください。

戻り値

このコールバック関数は値を返しません。

注釈

呼び出し元は、キューを閉じる前に、以前に投稿されたすべての要求を待機してドレインする必要があります。 呼び出し元は、この呼び出しの後に、それ以上 のPD_BUFFER 構造体をキューにポストすることはできません。 このルーチンの主なユース ケースは、受信キューをフラッシュすることです。受信トラフィックがない場合、ポストされたバッファーは無期限に受信キューに配置され、キューを閉じる前にフラッシュしてドレインする必要があります。 送信要求は無期限に処理されないため、実際には送信キューにも同じ問題は存在しません。 ただし、プロバイダーは送信キューのフラッシュ呼び出しを受け入れる必要があります (保留中の送信要求が非常に間もなく完了することをプロバイダーが認識している場合は、これは非操作である可能性があります。これは、L2 フロー制御を除く一般的なケースです)。

例

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

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

NDIS_PD_FLUSH_QUEUE MyPDFlushQueue;

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

_Use_decl_annotations_
VOID
 MyPDFlushQueue(
    NDIS_PD_QUEUE*  NdisPDQueue
    )
  {...}

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

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

要件

要件	値
サポートされている最小のクライアント	Windows 10
サポートされている最小のサーバー	Windows Server 2016
対象プラットフォーム	Windows
ヘッダー	ndis.h
IRQL	<= DISPATCH_LEVEL