GetMulticastIpAddressEntry, fonction
La fonction GetMulticastIpAddressEntry récupère des informations pour une entrée d’adresse IP de multidiffusion existante sur un ordinateur local.
Syntaxe
NETIOAPI_API GetMulticastIpAddressEntry(
_Inout_ PMIB_MULTICASTIPADDRESS_ROW Row
);
Paramètres
- Ligne [in, out]
Pointeur vers une entrée de structure MIB_MULTICASTIPADDRESS_ROW pour une entrée d’adresse IP de multidiffusion. En cas de retour réussi, cette structure est mise à jour avec les propriétés d’une adresse IP de multidiffusion existante.
Valeur retournée
GetMulticastIpAddressEntry retourne STATUS_SUCCESS si la fonction réussit.
Si la fonction échoue, GetMulticastIpAddressEntry retourne l’un des codes d’erreur suivants :
| Code de retour | Description |
|---|---|
| STATUS_INVALID_PARAMETER | Un paramètre non valide a été transmis à la fonction. Cette erreur est retournée si un pointeur NULL est passé dans le paramètre Row , si le membre Address de la structure MIB_MULTICASTIPADDRESS_ROW vers laquelle pointe le paramètre Row n’a pas été défini sur une adresse IPv4 ou IPv6 de multidiffusion valide, ou si les membres InterfaceLuid et InterfaceIndex de la structure MIB_MULTICASTIPADDRESS_ROW n’ont pas été spécifiés. |
| STATUS_NOT_FOUND | L’interface spécifiée est introuvable. Cette erreur est retournée si la fonction ne trouve pas l’interface réseau spécifiée par le membre InterfaceLuid ou InterfaceIndex de la structure MIB_MULTICASTIPADDRESS_ROW vers laquelle pointe le paramètre Row . |
| STATUS_NOT_SUPPORTED | La demande n'est pas prise en charge. Cette erreur est retournée si aucune pile IPv4 ne se trouve sur l’ordinateur local et qu’une adresse IPv4 a été spécifiée dans le membre Address de la structure MIB_MULTICASTIPADDRESS_ROW vers laquelle pointe le paramètre Row , ou si aucune pile IPv6 ne se trouve sur l’ordinateur local et qu’une adresse IPv6 a été spécifiée dans le membre Address . |
| Autres | Utilisez la fonction FormatMessage pour obtenir la chaîne de message de l’erreur retournée. |
Notes
La fonction GetMulticastIpAddressEntry est utilisée pour récupérer une entrée de structure MIB_MULTICASTIPADDRESS_ROW existante.
Lors de l’entrée, votre pilote doit initialiser les membres suivants de la structure MIB_MULTICASTIPADDRESS_ROW vers laquelle pointe le paramètre Row .
Adresse
Définissez sur une adresse et une famille IPv4 ou IPv6 valides.InterfaceLuid ou InterfaceIndex
Ces membres sont utilisés dans l’ordre indiqué précédemment. Par conséquent, si InterfaceLuid est spécifié, ce membre est utilisé pour déterminer l’interface. Si aucune valeur n’a été définie pour le membre InterfaceLuid (la valeur de ce membre a été définie sur zéro), le membre InterfaceIndex est ensuite utilisé pour déterminer l’interface.
Lors de la sortie, lorsque l’appel réussit, GetMulticastIpAddressEntry récupère les autres propriétés de l’adresse IP de multidiffusion et remplit la structure MIB_MULTICASTIPADDRESS_ROW vers laquelle pointe le paramètre Row .
Votre pilote peut appeler la fonction GetMulticastIpAddressTable pour énumérer les entrées d’adresse IP de multidiffusion sur un ordinateur local.
Spécifications
Plateforme cible |
Universal |
Version |
Disponible dans Windows Vista et versions ultérieures des systèmes d’exploitation Windows. |
En-tête |
Netioapi.h (inclure Netioapi.h) |
Bibliothèque |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |