GetAnycastIpAddressTable, fonction
La fonction GetAnycastIpAddressTable récupère la table d’adresses IP anycast sur un ordinateur local.
Syntaxe
NETIOAPI_API GetAnycastIpAddressTable(
_In_ ADDRESS_FAMILY Family,
_Out_ PMIB_ANYCASTIPADDRESS_TABLE *Table
);
Paramètres
Famille [in]
Famille d’adresses à récupérer.Les valeurs possibles pour la famille d’adresses sont répertoriées dans le fichier d’en-tête Winsock2.h. Notez que les valeurs de la famille d’adresses AF_ et des constantes de famille de protocoles PF_ sont identiques (par exemple, AF_INET et PF_INET), afin de pouvoir utiliser l’une ou l’autre constante.
Sur Windows Vista et les versions ultérieures des systèmes d’exploitation Windows, les valeurs possibles pour le paramètre Family sont définies dans le fichier d’en-tête Ws2def.h. Notez que le fichier d’en-tête Ws2def.h est automatiquement inclus dans Netioapi.h et que vous ne devez jamais utiliser Ws2def.h directement.
Les valeurs suivantes sont actuellement prises en charge pour la famille d’adresses :
AF_INET
Famille d’adresses IPv4. Lorsque cette valeur est spécifiée, cette fonction retourne la table d’adresses IP anycast qui contient uniquement des entrées IPv4.AF_INET6
Famille d’adresses IPv6. Lorsque cette valeur est spécifiée, cette fonction retourne la table d’adresses IP anycast qui contient uniquement des entrées IPv6.AF_UNSPEC
La famille d’adresses n’est pas spécifiée. Lorsque cette valeur est spécifiée, cette fonction retourne la table d’adresses IP anycast qui contient les entrées IPv4 et IPv6.
Table [out]
Pointeur vers une structure MIB_ANYCASTIPADDRESS_TABLE qui contient une table des entrées d’adresse IP de toute diffusion sur l’ordinateur local.
Valeur retournée
GetAnycastIpAddressTable retourne STATUS_SUCCESS si la fonction réussit.
Si la fonction échoue, GetAnycastIpAddressTable retourne l’un des codes d’erreur suivants :
| Code de retour | Description |
|---|---|
| STATUS_INVALID_PARAMETER | Un paramètre non valide a été passé à la fonction. Cette erreur est retournée si un pointeur NULL est passé dans le paramètre Table ou si le paramètre Family n’a pas été spécifié comme AF_INET, AF_INET6 ou AF_UNSPEC. |
| STATUS_NOT_ENOUGH_MEMORY | Les ressources de mémoire insuffisantes sont disponibles pour terminer l’opération. |
| STATUS_NOT_FOUND | Aucune entrée d’adresse IP anycast, comme spécifié dans le paramètre Family , a été trouvée. |
| STATUS_NOT_SUPPORTED | La demande n'est pas prise en charge. Cette erreur est retournée si aucune pile IPv4 n’est située sur l’ordinateur local et que AF_INET a été spécifié dans le paramètre Family, ou si aucune pile IPv6 n’est située sur l’ordinateur local et que AF_INET6 a été spécifié dans le paramètre Family. Cette erreur est également retournée sur les versions de Windows où cette fonction n’est pas prise en charge. |
| Autres | Utilisez la fonction FormatMessage pour obtenir la chaîne de message correspondant à l’erreur renvoyée. |
Notes
La fonction GetAnycastIpAddressTable énumère les adresses IP anycast sur un ordinateur local et retourne ces informations dans une structure MIB_ANYCASTIPADDRESS_TABLE .
Les entrées d’adresse IP anycast sont retournées dans une structure MIB_ANYCASTIPADDRESS_TABLE dans la mémoire tampon vers laquelle pointe le paramètre Table . La structure MIB_ANYCASTIPADDRESS_TABLE contient un nombre d’entrées d’adresse IP anycast et un tableau de structures MIB_ANYCASTIPADDRESS_ROW pour chaque entrée d’adresse IP anycast. Lorsque ces structures retournées ne sont plus nécessaires, votre pilote doit libérer la mémoire en appelant FreeMibTable.
Votre pilote doit initialiser le paramètre Family sur AF_INET, AF_INET6 ou AF_UNSPEC.
Notez que la structure MIB_ANYCASTIPADDRESS_TABLE retournée à laquelle le paramètre Table pointe peut contenir un remplissage pour l’alignement entre le membre NumEntries et la première entrée de tableau MIB_ANYCASTIPADDRESS_ROW dans le membre Table de la structure MIB_ANYCASTIPADDRESS_TABLE. Le remplissage pour l’alignement peut également être présent entre les entrées de tableau MIB_ANYCASTIPADDRESS_ROW. Tout accès à une entrée de tableau MIB_ANYCASTIPADDRESS_ROW doit supposer que le remplissage peut exister.
Spécifications
Plateforme cible |
Universal |
Version |
Disponible sous Windows Vista et les versions ultérieures du système d’exploitation Windows. |
En-tête |
Netioapi.h (inclure Netioapi.h) |
Bibliothèque |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |