FILTER_OID_REQUEST回呼函式 (ndis.h)

發行項
02/26/2024

NDIS 會呼叫篩選驅動程式的 FilterOidRequest 函式來處理與指定篩選模組相關聯的 OID 要求。

注意您必須使用 FILTER_OID_REQUEST 類型來宣告函式。如需詳細資訊，請參閱下列範例一節。

語法

FILTER_OID_REQUEST FilterOidRequest;

NDIS_STATUS FilterOidRequest(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PNDIS_OID_REQUEST OidRequest
)
{...}

參數

[in] FilterModuleContext

此要求目標之篩選模組的內容區域句柄。篩選驅動程式已在 FilterAttach 函式中建立並初始化此內容區域。

[in] OidRequest

NDIS_OID_REQUEST 結構的指標，指定要求的作業，包括 OID_XXX 程序代碼。結構可以指定 OID 查詢要求或 OID 集合要求。如需 OID 的詳細資訊，請參閱 NDIS OID。

傳回值

FilterOidRequest 會傳回下列其中一個狀態值：

傳回碼	Description
NDIS_STATUS_SUCCESS	FilterOidRequest 已成功完成篩選驅動程式的查詢或設定此篩選模組的作業。
NDIS_STATUS_PENDING	表示篩選驅動程式會以異步方式完成要求。驅動程式完成要求之後，必須呼叫 NdisFOidRequestComplete 函式會通知 NDIS 要求已完成。
NDIS_STATUS_INVALID_OID	表示在 OidRequest 指定的要求無效或無法辨識。
NDIS_STATUS_NOT_SUPPORTED	FilterOidRequest 不支援 OID，OID 是選擇性的。
NDIS_STATUS_BUFFER_TOO_SHORT	表示在 OidRequest 提供的緩衝區太小，無法保存要求的數據。
NDIS_STATUS_INVALID_LENGTH	針對查詢作業，NDIS_OID_REQUEST 結構的 InformationBufferLength 成員不符合指定 OID 所需的長度。 FilterOidRequest 傳回NDIS_OID_REQUEST結構之 BytesNeeded 成員中所需的緩衝區大小，以位元組為單位。
NDIS_STATUS_INVALID_DATA	針對設定作業，在指定的 OID 中，NDIS_OID_REQUEST 結構之 InformationBuffer 成員中提供的數據無效。
NDIS_STATUS_NOT_ACCEPTED	FilterOidRequest 嘗試收集要求的資訊，但失敗。
NDIS_STATUS_RESOURCES	FilterOidRequest 因為資源不足而失敗。
NDIS_STATUS_FAILURE	如果上述值都未套用，FilterOidRequest 會傳回NDIS_STATUS_FAILURE。篩選驅動程序應該使用指定失敗原因的參數呼叫 NdisWriteErrorLogEntry 函式。

備註

FilterOidRequest 是選擇性函式。如果篩選驅動程式未使用 OID 要求，它可以在呼叫 NdisFRegisterFilterDriver 函式時，將此函式的進入點設定為 NULL。如果篩選驅動程式定義 FilterOidRequestComplete 函式，則必須提供 FilterOidRequest 函式。

NDIS 會呼叫篩選驅動程式的 FilterOidRequest 函式，以處理源自過度驅動程式的 OID 要求。篩選驅動程式可以呼叫 NdisFOidRequest 函式，將這類要求轉送至基礎驅動程式。

在驅動程式呼叫 NdisFOidRequest 之前，驅動程式必須配置 NDIS_OID_REQUEST 結構，並藉由呼叫 NdisAllocateCloneOidRequest 將要求資訊傳送至新結構。作為選項，篩選驅動程式可以立即完成要求，而不需要轉送要求。

若要同步完成要求，篩選驅動程式會傳回NDIS_STATUS_SUCCESS或失敗狀態。如果驅動程式傳回NDIS_STATUS_PENDING，它必須呼叫 NdisFOidRequestComplete 函式，以通知 NDIS 要求已完成。

針對查詢作業， FilterOidRequest 會傳回 InformationBuffer 成員中所要求的資訊，並將NDIS_OID_REQUEST 結構的 BytesWritten 成員中的變數設定為傳回的資訊量。如果篩選驅動程式使用 NdisFOidRequest 傳遞要求，則基礎驅動程式會執行此動作。

針對設定作業， FilterOidRequest 可以使用NDIS_OID_REQUEST結構 InformationBuffer 成員中的數據來設定指定 OID 所需的資訊。在此情況下， FilterOidRequest 會將 位於 BytesRead 的變數設定為所提供數據的數量。如果篩選驅動程式使用 NdisFOidRequest 傳遞要求，則基礎驅動程式會執行此動作。

如同迷你埠驅動程式，篩選驅動程式一次只能接收一個要求。 NDIS 會將傳送至篩選驅動程式的要求串行化。在篩選驅動程式完成目前要求之前，NDIS 無法呼叫 FilterOidRequest 。

NDIS 會在 IRQL <= DISPATCH_LEVEL呼叫 FilterOidRequest。

例子

若要定義 FilterOidRequest 函式，您必須先提供函式宣告，以識別您要定義的函式類型。 Windows 提供一組驅動程式的函式類型。使用函式類型宣告函式有助於驅動程式的程式代碼分析、靜態驅動程序驗證器 (SDV) ，以及其他驗證工具會尋找錯誤，而且這是撰寫 Windows 操作系統驅動程式的需求。

例如，若要定義名為「 MyOidRequest」的 FilterOidRequest 函式，請使用 FILTER_OID_REQUEST 類型，如下列程式代碼範例所示：

FILTER_OID_REQUEST MyOidRequest;

然後，實作您的函式，如下所示：

_Use_decl_annotations_
NDIS_STATUS
 MyOidRequest(
    NDIS_HANDLE  FilterModuleContext,
    PNDIS_OID_REQUEST  OidRequest
    )
  {...}

FILTER_OID_REQUEST函式類型定義於 Ndis.h 頭檔中。若要在執行程式代碼分析工具時更精確地識別錯誤，請務必將 Use_decl_annotations 註釋新增至函式定義。 Use_decl_annotations註釋可確保使用頭檔中套用至FILTER_OID_REQUEST函式類型的批註。如需函式宣告需求的詳細資訊，請參閱使用 NDIS 驅動程式的函式角色類型來宣告函式。

如需 Use_decl_annotations的詳細資訊，請參閱標註函式行為。