PROTOCOL_CM_DROP_PARTY fonction de rappel (ndis.h)

Article
08/07/2023

La fonction ProtocolCmDropParty est requise. NDIS appelle ProtocolCmDropParty pour demander que le gestionnaire d’appels supprime une partie d’un appel multipoint existant.

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

Syntaxe

PROTOCOL_CM_DROP_PARTY ProtocolCmDropParty;

NDIS_STATUS ProtocolCmDropParty(
  [in]           NDIS_HANDLE CallMgrPartyContext,
  [in, optional] PVOID CloseData,
  [in, optional] UINT Size
)
{...}

Paramètres

[in] CallMgrPartyContext

Spécifie le handle d’une zone de contexte allouée par le gestionnaire d’appels dans laquelle le gestionnaire d’appels conserve son état par partie. Ce handle a été fourni à NDIS dans la fonction ProtocolCmAddParty des gestionnaires d’appels.

[in, optional] CloseData

Pointeur vers une mémoire tampon contenant des données spécifiques au client orientées connexion qui doivent être envoyées sur la connexion avant la suppression de la partie. Ce paramètre a la valeur NULL si le support réseau sous-jacent ne prend pas en charge les transferts de données lors de la fermeture d’une connexion.

[in, optional] Size

Spécifie la longueur, en octets, de la mémoire tampon sur CloseData, zéro si CloseData a la valeur NULL.

Valeur retournée

ProtocolCmDropParty retourne la status de ses opérations sous la forme d’une des valeurs suivantes :

Code de retour	Description
NDIS_STATUS_SUCCESS	Indique que le gestionnaire d’appels a réussi à supprimer la partie, envoyé toutes les données de fermeture et libéré les ressources qui ont été allouées pour sa zone de contexte.
NDIS_STATUS_PENDING	Indique que le gestionnaire d’appels termine la demande de suppression asynchrone de la partie. Le gestionnaire d’appels doit appeler NdisCmDropPartyComplete lorsque tout le traitement est terminé pour informer NDIS et l’acteur demandeur que la partie a été supprimée.
NDIS_STATUS_INVALID_DATA	Indique que CloseData a été spécifié pour le gestionnaire d’appels, mais que le type de média ne prend pas en charge l’envoi de données en même temps que l’arrêt de la connexion.

Remarques

ProtocolCmDropParty communique avec des appareils de contrôle réseau ou d’autres agents spécifiques au média, selon les besoins de son média, pour supprimer une partie d’un appel multipoint existant. Si le gestionnaire d’appels doit communiquer avec les agents de contrôle réseau (par exemple, un commutateur réseau), il doit utiliser une connexion virtuelle aux agents de contrôle réseau qu’il a établis dans son Fonction ProtocolBindAdapterEx .

Si CloseData n’a pas la valeur NULL et que l’envoi de données à l’arrêt de la connexion est pris en charge par son type de média, le gestionnaire d’appels doit transmettre les données spécifiées dans CloseData avant de terminer l’arrêt. Si l’envoi de données en même temps que l’arrêt de la connexion n’est pas pris en charge par le type de média, le gestionnaire d’appels doit retourner le contrôle avec NDIS_STATUS_INVALID_DATA.

Les responsables d’appels doivent également libérer toutes les ressources par partie qu’ils ont allouées et stockées dans CallMgrPartyContext . En outre, le gestionnaire d’appels doit libérer la mémoire tampon stockée CallMgrPartyContext elle-même. Si vous ne le faites pas, vous obtiendrez une condition de fuite de mémoire.

Exemples

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

PROTOCOL_CM_DROP_PARTY MyCmDropParty;

Ensuite, implémentez votre fonction comme suit :

_Use_decl_annotations_
NDIS_STATUS
 MyCmDropParty(
    NDIS_HANDLE  CallMgrPartyContext,
    PVOID  CloseData,
    UINT  Size
    )
  {...}

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

Voir aussi

NdisCmDropPartyComplete

ProtocolCmAddParty

Partager via