PROTOCOL_CO_DELETE_VC fonction de rappel (ndis.h)

Article
02/26/2024

La fonction ProtocolCoDeleteVc est requise. Cette fonction supprime l’état du client ou du gestionnaire d’appels pour une connexion virtuelle établie qui est fermée par le créateur d’origine de cette VC.

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

Syntaxe

PROTOCOL_CO_DELETE_VC ProtocolCoDeleteVc;

NDIS_STATUS ProtocolCoDeleteVc(
  [in] NDIS_HANDLE ProtocolVcContext
)
{...}

Paramètres

[in] ProtocolVcContext

Spécifie le handle dans la zone de contexte par VC du client ou du gestionnaire d’appels. Le protocole a initialement fourni ce handle à partir de sa fonction ProtocolCoCreateVc .

Valeur retournée

ProtocolCoDeleteVc peut retourner l’un des éléments suivants :

Code de retour	Description
NDIS_STATUS_SUCCESS	Le protocole a libéré ou préparé la réutilisation de toutes les ressources qu’il avait initialement allouées pour le vc.
NDIS_STATUS_NOT_ACCEPTED	Le vc est toujours actif et le protocole a des opérations en attente sur le vc. Il n’a donc pas pu être détruit.
NDIS_STATUS_XXX	Le protocole a échoué à la suppression du vc pour une raison déterminée par le pilote.

Remarques

ProtocolCoDeleteVc est la réciproque de la fonction ProtocolCoCreateVc du pilote. En général, il libère toutes les ressources et structures dynamiques que le gestionnaire d’appels ou le client ont précédemment allouées pour effectuer des opérations sur le vc actif.

Lorsque ProtocolCoDeleteVc retourne le contrôle avec NDIS_STATUS_SUCCESS, le NdisVcHandle que sa fonction ProtocolCoCreateVc stockée dans la zone de ProtocolVcContext ne devient pas valide.

ProtocolCoDeleteVc peut retourner n’importe quel NDIS_STATUS_XXX déterminé par le pilote pour faire échouer la suppression du VC, mais il ne peut pas retourner NDIS_STATUS_PENDING. Les appels à ProtocolCoDeleteVc sont par nature synchrones.

Exemples

Pour définir une fonction ProtocolCoDeleteVc , 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 ProtocolCoDeleteVc nommée « MyCoDeleteVc », utilisez le type PROTOCOL_CO_DELETE_VC comme indiqué dans cet exemple de code :

PROTOCOL_CO_DELETE_VC MyCoDeleteVc;

Ensuite, implémentez votre fonction comme suit :

_Use_decl_annotations_
NDIS_STATUS
 MyCoDeleteVc(
    NDIS_HANDLE  ProtocolVcContext
    )
  {...}

Le type de fonction PROTOCOL_CO_DELETE_VC 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 PROTOCOL_CO_DELETE_VC 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 pour les pilotes NDIS 6.0 et NDIS 5.1 (voir ProtocolCoDeleteVc (NDIS 5.1)) dans Windows Vista. Pris en charge pour les pilotes NDIS 5.1 (consultez ProtocolCoDeleteVc (NDIS 5.1)) dans Windows XP.
Plateforme cible	Windows
En-tête	ndis.h (inclure Ndis.h)
IRQL	<= DISPATCH_LEVEL