GetAnycastIpAddressEntry, fonction (netioapi.h)

Article
03/04/2024

La fonction GetAnycastIpAddressEntry récupère les informations d’une entrée d’adresse IP anycast existante sur l’ordinateur local.

Syntaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetAnycastIpAddressEntry(
  [in, out] PMIB_ANYCASTIPADDRESS_ROW Row
);

Paramètres

[in, out] Row

Pointeur vers une entrée de structure MIB_ANYCASTIPADDRESS_ROW pour une entrée d’adresse IP anycast. En cas de retour réussi, cette structure est mise à jour avec les propriétés d’une adresse IP anycast existante.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Code de retour	Description
ERROR_FILE_NOT_FOUND	Le système ne peut pas trouver le fichier spécifié. Cette erreur est retournée si l’interface réseau LUID ou l’index d’interface spécifié par le membre InterfaceLuid ou InterfaceIndex du MIB_ANYCASTIPADDRESS_ROW pointé par le paramètre Row n’est pas une valeur sur l’ordinateur local.
ERROR_INVALID_PARAMETER	Un paramètre est incorrect. Cette erreur est retournée si un pointeur NULL est transmis dans le paramètre Row , si le membre Address du MIB_ANYCASTIPADDRESS_ROW pointé par le paramètre Row n’est pas défini sur une adresse IPv4 ou IPv6 anycast valide, ou si les membres InterfaceLuid ou InterfaceIndex du MIB_ANYCASTIPADDRESS_ROW pointés par le paramètre Row n’ont pas été spécifiés.
ERROR_NOT_FOUND	Element not found. Cette erreur est retournée si l’interface réseau spécifiée par le membre InterfaceLuid ou InterfaceIndex de la structure MIB_ANYCASTIPADDRESS_ROW pointée par le paramètre Row ne correspond pas à l’adresse IP et à la famille d’adresses spécifiées dans le membre Address de la structure MIB_ANYCASTIPADDRESS_ROW .
ERROR_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 est spécifiée dans le membre Address de la structure MIB_UNICASTIPADDRESS_ROW pointée vers le paramètre Row . Cette erreur est retournée si aucune pile IPv6 ne se trouve sur l’ordinateur local et si une adresse IPv6 est spécifiée dans le membre Address .
Autres	Utilisez FormatMessage pour obtenir la chaîne de message de l’erreur retournée.

Remarques

La fonction GetAnycastIpAddressEntry est définie sur Windows Vista et versions ultérieures.

La fonction GetAnycastIpAddressEntry est utilisée pour récupérer une entrée de structure MIB_ANYCASTIPADDRESS_ROW existante.

Lors de l’entrée, le membre Address dans la structure MIB_ANYCASTIPADDRESS_ROW pointée vers le paramètre Row doit être initialisé vers une adresse IPv4 ou IPv6 anycast valide et une famille. En outre, au moins l’un des membres suivants dans la structure MIB_ANYCASTIPADDRESS_ROW pointant vers le paramètre Row doit être initialisé : InterfaceLuid ou InterfaceIndex.

Les champs sont utilisés dans l’ordre indiqué ci-dessus. Ainsi, si l’InterfaceLuid est spécifié, ce membre est utilisé pour déterminer l’interface. Si aucune valeur n’est définie pour le membre InterfaceLuid (la valeur de ce membre est 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, GetAnycastIpAddressEntry récupère les autres propriétés de l’adresse IP anycast et remplit la structure MIB_ANYCASTIPADDRESS_ROW pointée par le paramètre Row .

La fonction GetAnycastIpAddressTable peut être appelée pour énumérer les entrées d’adresse IP anycast sur un ordinateur local.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	netioapi.h (include Iphlpapi.h)
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll