PROTOCOL_CL_DEREGISTER_SAP_COMPLETE fonction de rappel (ndis.h)

Article
02/07/2025

La fonction ProtocolClDeregisterSapComplete est utilisée par les clients NDIS orientés connexion. Les clients NDIS orientés connexion qui acceptent les appels entrants doivent avoir fonctions ProtocolClDeregisterSapComplete pour effectuer les opérations asynchrones qu’ils lancent avec NdisClDeregisterSap. Dans le cas contraire, la fonction ProtocolClDeregisterSapComplete d’un pilote de protocole peut simplement retourner le contrôle.

Remarque Vous devez déclarer la fonction à l’aide du type PROTOCOL_CL_DEREGISTER_SAP_COMPLETE. Pour plus d’informations, consultez la section Exemples suivants.

Syntaxe

PROTOCOL_CL_DEREGISTER_SAP_COMPLETE ProtocolClDeregisterSapComplete;

void ProtocolClDeregisterSapComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolSapContext
)
{...}

Paramètres

[in] Status

Spécifie l’état final de la demande du client pour désinscrire son SAP, qui peut être l’un des éléments suivants :

NDIS_STATUS_SUCCESS

Sap a été fermé. Le NdisSapHandle qui représentait le SAP précédemment inscrit du client, que le client a stocké dans sa zone ProtocolSapContext, n’est plus valide.

NDIS_STATUS_FAILURE

NDIS avait marqué l’état de l’AF comme « fermant », de sorte que le SAP associé représenté par le NdisSapHandle a déjà été publié lors de l’appel du client à NdisClDeregisterSap s’est produit.

NDIS_STATUS_XXX

Le gestionnaire d’appels a échoué la requête pour fermer SAP pour une raison déterminée par CM, et NDIS a propagé l’état retourné par son ProtocolCmDeregisterSap fonction au client.

[in] ProtocolSapContext

Spécifie le handle fourni par le client dans sa zone de contexte par SAP, à l’origine passée à NDIS avec NdisClRegisterSap. Une fois que le gestionnaire d’appels a correctement inscrit ce SAP, le client peut libérer sa zone de contexte ou préparer cette zone de contexte pour une réutilisation.

Valeur de retour

Aucun

Remarques

Un appel à ProtocolClDeregisterSapComplete indique que l’appel précédent du client à NdisClDeregisterSap a été traité par le gestionnaire d’appels.

Sauf si le gestionnaire d’appels a échoué la désinscription pour une raison déterminée par CM, le client doit prendre en compte la NdisSapHandle non valide lorsque ProtocolClDeregisterSapComplete est appelée. Par conséquent, ProtocolClDeregisterSapComplete peut libérer la zone de contexte par SAP allouée par le client ou la préparer pour une réutilisation dans un appel ultérieur à NdisClRegisterSap.

exemples de

Pour définir une fonction ProtocolClDeregisterSapComplete, 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 fonctions permet d'Analyse du code pour les pilotes, de vérificateur de pilotes statiques (SDV) et d’autres outils de vérification recherchent des erreurs, et il est nécessaire d’écrire des pilotes pour le système d’exploitation Windows.

Par exemple, pour définir une fonction ProtocolClDeregisterSapComplete nommée « MyClDeregisterSapComplete », utilisez le type PROTOCOL_CL_DEREGISTER_SAP_COMPLETE comme indiqué dans cet exemple de code :

PROTOCOL_CL_DEREGISTER_SAP_COMPLETE MyClDeregisterSapComplete;

Ensuite, implémentez votre fonction comme suit :

_Use_decl_annotations_
VOID
 MyClDeregisterSapComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolSapContext
    )
  {...}

Le type de fonction PROTOCOL_CL_DEREGISTER_SAP_COMPLETE est défini dans le fichier d’en-tête Ndis.h. Pour identifier plus précisément les erreurs lorsque vous exécutez les 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 PROTOCOL_CL_DEREGISTER_SAP_COMPLETE 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 annoter le comportement de la fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Pris en charge pour les pilotes NDIS 6.0 et NDIS 5.1 (voir ProtocolClDeregisterSapComplete (NDIS 5.1)) dans Windows Vista. Pris en charge pour les pilotes NDIS 5.1 (voir ProtocolClDeregisterSapComplete (NDIS 5.1)) dans Windows XP.
plateforme cible	Windows
d’en-tête	ndis.h (include Ndis.h)
IRQL	<= DISPATCH_LEVEL