NdisFSynchronousOidRequest function (ndis.h)

Article
02/22/2024

Filter drivers call the NdisFSynchronousOidRequest function to originate a new Synchronous OID request and issue it to underlying drivers.

This function is supported in NDIS 6.81 and later.

Syntax

NDIS_STATUS NdisFSynchronousOidRequest(
  [in] NDIS_HANDLE      NdisFilterModuleHandle,
  [in] NDIS_OID_REQUEST *OidRequest
);

Parameters

[in] NdisFilterModuleHandle

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

This function returns the same values as NdisDirectOidRequest except that NDIS_STATUS_PENDING is never returned from this function.

Remarks

The NdisFSynchronousOidRequest function cannot be used for general OID requests. For general OID requests, use the NdisFOidRequest function instead. NdisFSynchronousOidRequest can be used only for OIDs that NDIS supports for use with the Synchronous OID interface. Most filter drivers do not need to call NdisFSynchronousOidRequest.

Filter drivers must not complete FilterDetach until any Synchronous OID requests originated by the filter driver are completed.

Filter drivers are not required to implement FilterOidRequestComplete, FilterDirectOidRequestComplete, FilterSynchronousOidRequest, or FilterSynchronousOidRequestComplete in order to call NdisFSynchronousOidRequest. As its name suggests, a Synchronous OID request always completes synchronously, so there is no asynchronous callback.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1709
Target Platform	Universal
Header	ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	<= DISPATCH_LEVEL