FILTER_CANCEL_OID_REQUEST fonction de rappel (ndis.h)

Article
08/07/2023

NDIS appelle la fonction FilterCancelOidRequest d’un pilote de filtre pour annuler une requête OID.

Note Vous devez déclarer la fonction à l’aide du type FILTER_CANCEL_OID_REQUEST . Pour plus d’informations, consultez la section Exemples suivante.

Syntaxe

FILTER_CANCEL_OID_REQUEST FilterCancelOidRequest;

void FilterCancelOidRequest(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PVOID RequestId
)
{...}

Paramètres

[in] FilterModuleContext

Handle de la zone de contexte pour le module de filtre qui est la cible de cette requête. Le pilote de filtre a créé et initialisé cette zone de contexte dans la fonction FilterAttach .

[in] RequestId

Identificateur d’annulation de la demande. Cet identificateur spécifie les structures NDIS_OID_REQUEST qui sont annulées.

Valeur de retour

None

Remarques

FilterCancelOidRequest est une fonction facultative. Si un pilote de filtre n’utilise pas les requêtes OID, il peut définir le point d’entrée de cette fonction sur NULL lorsqu’il appelle le Fonction NdisFRegisterFilterDriver .

Lorsque NDIS appelle FilterCancelOidRequest, le pilote de filtre doit tenter d’appeler la fonction NdisFOidRequestComplete dès que possible.

Les paramètres de requête sont définis dans la structure NDIS_OID_REQUEST sur OidRequest .

Si un pilote de filtre ne met pas en file d’attente les requêtes OID, il n’est pas nécessaire de fournir une fonction FilterCancelOidRequest . Si le pilote de filtre ne spécifie pas de point d’entrée FilterCancelOidRequest , NDIS appelle la fonction de requête OID d’annulation du pilote sous-jacent.

NDIS appelle la fonction FilterCancelOidRequest soit lorsque l’initiateur de la demande annule la demande, soit lorsque le délai d’expiration spécifié au membre Timeout expire.

Si le traitement de la demande n’est toujours pas terminé dans un pilote de filtre, le pilote appelle la fonction NdisFOidRequestComplete avec le status défini sur NDIS_STATUS_REQUEST_ABORTED.

Si le pilote de filtre a transféré la demande à un pilote sous-jacent et que le traitement n’est toujours pas terminé, le pilote de filtre appelle la fonction NdisFCancelOidRequest avec le paramètre OidRequest défini sur la valeur qu’il a envoyée au pilote sous-jacent.

NDIS appelle FilterCancelOidRequest à IRQL <= DISPATCH_LEVEL.

Exemples

Pour définir une fonction FilterCancelOidRequest , vous devez d’abord fournir une déclaration de fonction qui identifie le type de fonction que vous définissez. Windows fournit un ensemble de types de fonctions pour les pilotes. La déclaration d’une fonction à l’aide des types de fonction permet à l’analyse du code pour les pilotes, le vérificateur de pilotes statique (SDV) et d’autres outils de vérification de trouver les erreurs, et il s’agit d’une exigence pour l’écriture de pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une fonction FilterCancelOidRequest nommée « MyCancelOidRequest », utilisez le type FILTER_CANCEL_OID_REQUEST comme indiqué dans cet exemple de code :

FILTER_CANCEL_OID_REQUEST MyCancelOidRequest;

Ensuite, implémentez votre fonction comme suit :

_Use_decl_annotations_
VOID
 MyCancelOidRequest(
    NDIS_HANDLE  FilterModuleContext,
    PVOID  RequestId
    )
  {...}

Le type de fonction FILTER_CANCEL_OID_REQUEST est défini dans le fichier d’en-tête Ndis.h. Pour identifier plus précisément les erreurs lors de l’exécution des outils d’analyse du code, veillez à ajouter l’annotation Use_decl_annotations à votre définition de fonction. L’annotation Use_decl_annotations garantit que les annotations appliquées au type de fonction FILTER_CANCEL_OID_REQUEST dans le fichier d’en-tête sont utilisées. Pour plus d’informations sur la configuration requise pour les déclarations de fonction, consultez Déclaration de fonctions à l’aide de types de rôles de fonction pour les pilotes NDIS.

Pour plus d’informations sur Use_decl_annotations, consultez Annotating Function Behavior.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Pris en charge dans NDIS 6.0 et versions ultérieures.
Plateforme cible	Windows
En-tête	ndis.h (inclure Ndis.h)
IRQL	<= DISPATCH_LEVEL