Share via

FilterCancelOidRequest (Compact 7)

  • Article

3/12/2014

NDIS calls a filter driver's FilterCancelOidRequest function to cancel an OID request.

Syntax

VOID
  FilterCancelOidRequest(
    IN NDIS_HANDLE  FilterModuleContext,
    IN PVOID  RequestId
    );

Parameters

  • FilterModuleContext
    A handle to the context area for the filter module that is the target of this request. The filter driver created and initialized this context area in the FilterAttach function.
  • RequestId
    A cancellation identifier for the request. This identifier specifies the NDIS_OID_REQUEST structures that are being canceled.

Return Value

None

Remarks

FilterCancelOidRequest is an optional function. If a filter driver does not use OID requests, it can set the entry point for this function to NULL when it calls the NdisFRegisterFilterDriver function.

When NDIS calls FilterCancelOidRequest, the filter driver should attempt to call NdisFOidRequestComplete function as soon as possible.

The request parameters are defined in the NDIS_OID_REQUEST structure at OidRequest.

If a filter driver does not queue OID requests, the driver is not required to provide a FilterCancelOidRequest function. If the filter driver does not specify a FilterCancelOidRequest entry point, NDIS calls the cancel OID request function of the underlying driver.

NDIS calls the FilterCancelOidRequest function either when the originator of the request cancels the request or when the time-out specified at the Time-Out member expires.

If the request processing is still incomplete in a filter driver, the driver calls the NdisFOidRequestComplete function with the status set to NDIS_STATUS_REQUEST_ABORTED.

If the filter driver forwarded the request to an underlying driver and the processing is still incomplete, the filter driver calls the NdisFCancelOidRequest function with the OidRequest parameter set to the value that it sent to the underlying driver.

NDIS calls FilterCancelOidRequest at IRQL <= DISPATCH_LEVEL.

Requirements

Header

filter.h

See Also

Reference

NDIS OID Request Interface for Filter Drivers
FilterAttach
NDIS_OID_REQUEST
NdisFCancelOidRequest
NdisFRegisterFilterDriver
NdisFOidRequestComplete