Partager via

PROTOCOL_CM_CLOSE_AF fonction de rappel (ndis.h)

  • Article

La fonction ProtocolCmCloseAf est une fonction obligatoire qui libère des ressources par ouverture pour une famille d’adresses prise en charge par un gestionnaire d’appels.

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

Syntaxe

PROTOCOL_CM_CLOSE_AF ProtocolCmCloseAf;

NDIS_STATUS ProtocolCmCloseAf(
  [in] NDIS_HANDLE CallMgrAfContext
)
{...}

Paramètres

[in] CallMgrAfContext

Spécifie le handle de la zone de contexte par AF du gestionnaire d’appels, initialement fourni à NDIS par la fonction ProtocolCmOpenAf du gestionnaire d’appels.

Valeur retournée

ProtocolCmCloseAf retourne le status de ses opérations comme suit :

Code de retour Description
NDIS_STATUS_SUCCESS
 Indique que le gestionnaire d’appels a correctement libéré ou désactivé toutes les ressources allouées pour le compte du client orienté connexion qui a ouvert cette instance de la famille d’adresses.
NDIS_STATUS_PENDING
 Indique que la demande de fermeture du instance ouvert de la famille d’adresses sera effectuée de manière asynchrone. Le gestionnaire d’appels doit appeler NdisCmCloseAddressFamilyComplete lorsque toutes ces opérations sont terminées.

Remarques

ProtocolCmCloseAf libère et/ou désactive toutes les ressources qui ont été allouées par le gestionnaire d’appels dans sa fonction ProtocolCmOpenAf . Le gestionnaire d’appels doit également annuler toutes les autres actions qu’il a effectuées au nom du client orienté connexion lorsque la famille d’adresses a été ouverte par ce client.

Si des demandes ou connexions en suspens sont toujours ouvertes sur une famille d’adresses stockée dans le CallMgrAfContext, un gestionnaire d’appels peut répondre à la demande d’un client de fermer la famille d’adresses de l’une des manières suivantes :

  • Le gestionnaire d’appels peut échouer la demande avec NDIS_STATUS_NOT_ACCEPTED.
  • Le gestionnaire d’appels peut retourner NDIS_STATUS_PENDING. Une fois que le client a fermé tous les appels et annulé l’inscription de tous les fournisseurs de services, le gestionnaire d’appels peut fermer la famille d’adresses et appeler NdisCmCloseAddressFamilyComplete ou NdisMCmCloseAddressFamilyComplete pour notifier le client. Il s’agit de la réponse préférée.

Exemples

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

PROTOCOL_CM_CLOSE_AF MyCmCloseAf;

Ensuite, implémentez votre fonction comme suit :

_Use_decl_annotations_
NDIS_STATUS
 MyCmCloseAf(
    NDIS_HANDLE  CallMgrAfContext
    )
  {...}

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

Voir aussi

NdisCmCloseAddressFamilyComplete

ProtocolCmOpenAf