NdisFDirectOidRequest function (ndis.h)

Article
10/21/2021

Filter drivers call the NdisFDirectOidRequest function to forward a direct OID request to underlying drivers or to originate such a request.

Syntax

NDIS_STATUS NdisFDirectOidRequest(
  [in] NDIS_HANDLE       NdisFilterHandle,
  [in] PNDIS_OID_REQUEST OidRequest
);

Parameters

[in] NdisFilterHandle

An NDIS handle that identifies a filter module. NDIS passed the handle to the filter driver in a call to the FilterAttach function.

[in] OidRequest

A pointer to an NDIS_OID_REQUEST structure that specifies the operation that is requested with a given OID_Xxx code. The structure can specify an OID query, set, or method request.

Return value

For a list of possible return values, see the NdisDirectOidRequest function.

Remarks

The NdisFDirectOidRequest function cannot be used for general OID requests. For general OID requests, use the NdisFOidRequest function instead. NdisFDirectOidRequest can be used only for OIDs that NDIS supports for use with the direct OID interface. For example, the following OIDs can be used:

OID_TCP_TASK_IPSEC_OFFLOAD_V2_ADD_SA OID_TCP_TASK_IPSEC_OFFLOAD_V2_DELETE_SA OID_TCP_TASK_IPSEC_OFFLOAD_V2_UPDATE_SA

Filter drivers can originate direct OID requests to underlying drivers by calling NdisFDirectOidRequest.

Filter drivers can also filter direct OID requests that are originated by overlying drivers. NDIS calls the FilterDirectOidRequest function to process each such request.

If NdisFDirectOidRequest returns NDIS_STATUS_PENDING, NDIS calls the FilterDirectOidRequestComplete function after the underlying drivers complete the OID request. A driver that calls NdisFDirectOidRequest must register the FilterDirectOidRequestComplete function.

A driver can call NdisFDirectOidRequest when it is in the Restarting, Running, Pausing, or Paused state.

The direct OID request interface is similar to the general OID request interface. For more information about issuing general requests, see NdisFOidRequest.

Requirements

Requirement	Value
Minimum supported client	Supported in NDIS 6.1 and later.
Target Platform	Desktop
Header	ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	<= DISPATCH_LEVEL