PROTOCOL_CM_DROP_PARTY fonction de rappel (ndis.h)

Article
02/07/2025

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

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

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 les gestionnaires d’appels ProtocolCmAddParty fonction.

[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 est 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 à closeData, zéro si CloseData est NULL.

Valeur de retour

ProtocolCmDropParty retourne l’état de ses opérations comme l’une des valeurs suivantes :

Retourner le code	Description
NDIS_STATUS_SUCCESS	Indique que le gestionnaire d’appels a supprimé la partie, envoyé toutes les données de fermeture et libérer les ressources allouées pour sa zone de contexte.
NDIS_STATUS_PENDING	Indique que le gestionnaire d’appels termine la demande de supprimer la partie de façon asynchrone. Le gestionnaire d’appels doit appeler NdisCmDropPartyComplete lorsque tout le traitement a été terminé pour notifier NDIS et l’acteur demandeur que la partie a été supprimée.
NDIS_STATUS_INVALID_DATA	Indique que CloseData a été spécifié au gestionnaire d’appels, mais que le type de média ne prend pas en charge l’envoi de données simultanées avec l’arrêt de la connexion.

Remarques

ProtocolCmDropParty communique avec des appareils de contrôle réseau ou d’autres agents spécifiques aux médias, selon les besoins de son média, pour supprimer un tiers 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’est pas 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 à CloseData avant la fin de l’arrêt. Si l’envoi de données simultanées à l’arrêt de 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 gestionnaires d’appels doivent également libérer toutes les ressources par partie qu’il a allouées et stockées à CallMgrPartyContext. En outre, le gestionnaire d’appels doit libérer la mémoire tampon stockée CallMgrPartyContext elle-même. L’échec de cette opération entraîne une condition de fuite de mémoire.

exemples de

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 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 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 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_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 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 ProtocolCmDropParty (NDIS 5.1)) dans Windows Vista. Pris en charge pour les pilotes NDIS 5.1 (voir ProtocolCmDropParty (NDIS 5.1)) dans Windows XP.
plateforme cible	Windows
d’en-tête	ndis.h (include Ndis.h)
IRQL	<= DISPATCH_LEVEL

Voir aussi

NdisCmDropPartyComplete

ProtocolCmAddParty

Partager via