Fonction RtlIpv6AddressToStringExW (ip2string.h)

La fonction RtlIpv6AddressToStringEx convertit une adresse IPv6, un ID d’étendue et un numéro de port en chaîne.

Syntaxe

NTSYSAPI NTSTATUS RtlIpv6AddressToStringExW(
  [in]      const in6_addr *Address,
  [in]      ULONG          ScopeId,
  [in]      USHORT         Port,
  [out]     PWSTR          AddressString,
  [in, out] PULONG         AddressStringLength
);

Paramètres

[in] Address

Adresse IPv6 dans l’ordre d’octet réseau.

[in] ScopeId

ID d’étendue de l’adresse IPv6 dans l’ordre d’octet réseau. Ce paramètre est facultatif.

[in] Port

Numéro de port au format d’ordre d’octet réseau. Ce paramètre est facultatif.

[out] AddressString

Pointeur vers la mémoire tampon pour recevoir la représentation sous forme de chaîne terminée par NULL de l’adresse IP, de l’ID d’étendue et du port. Cette mémoire tampon doit être suffisamment grande pour contenir au moins INET6_ADDRSTRLEN caractères. La valeur INET6_ADDRSTRLEN est définie dans le fichier d’en-tête Ws2ipdef.h .

[in, out] AddressStringLength

Lors de l’entrée, le nombre de caractères qui tiennent dans la mémoire tampon pointée par le paramètre AddressString , y compris le terminateur NULL. En sortie, ce paramètre contient le nombre de caractères réellement écrits dans la mémoire tampon pointée par le paramètre AddressString .

Valeur retournée

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

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

Remarques

La fonction RtlIpv6AddressToStringEx est utilisée pour convertir une adresse IPv6, un ID d’étendue et un numéro de port en représentation sous forme de chaîne de l’adresse IPv6 au format Internet suivi d’une représentation sous forme de chaîne de l’ID d’étendue suivi d’une représentation sous forme de chaîne du port. L’ID d’étendue et le numéro de port sont des paramètres facultatifs.

La représentation sous forme de chaîne de base de l’adresse IPv6 retournée se compose de 8 nombres hexadécimaux séparés par des points-virgules. Une chaîne de nombres hexadécimaux zéro consécutifs est remplacée par un double signe deux-points. Il ne peut y avoir qu’un seul signe deux-points dans la représentation sous forme de chaîne de l’adresse IPv6. Les 32 derniers bits sont représentés en notation d’octets en pointillés de style IPv4 si l’adresse est une adresse compatible IPv4, une adresse IPv4 mappée à IPv6 ou une adresse ISATAP. Pour plus d’informations, consultez la section 5 de la RFC 5942 publiée par l’IETF.

Si un ID d’étendue est fourni, la représentation sous forme de chaîne de l’ID d’étendue est séparée de la représentation sous forme de chaîne de l’adresse IPv6 par un caractère de pourcentage ('%'). Si un numéro de port est fourni, la représentation sous forme de chaîne de l’adresse IPv6 et l’ID d’étendue sont entourés d’accolades carrées (un caractère « [ » de début suivi de l’adresse IPv6 suivie d’un caractère «% » suivi de l’ID d’étendue avec un caractère de fin « ] ». Le numéro de port est représenté sous la forme d’un signe deux-points suivant le caractère d’accolade carrée droite suivi de la représentation sous forme de chaîne du numéro de port en décimal.

RtlIpv6AddressToStringEx est une fonction pratique qui ne nécessite pas que la DLL Windows Sockets soit chargée pour accéder à une fonction fournie dans Windows Sockets pour effectuer une adresse IP en conversion de chaîne.

Si la longueur de la mémoire tampon pointée par le paramètre AddressString n’est pas suffisamment grande pour recevoir la représentation sous forme de chaîne de l’adresse IP, de l’ID d’étendue et du port, RtlIpv6AddressToStringEx retourne ERROR_INVALID_PARAMETER et définit le paramètre AddressStringLength sur la longueur de la mémoire tampon requise.

Lorsque unicode ou _UNICODE est défini, RtlIpv6AddressToStringEx est défini sur RtlIpv6AddressToStringExW, la version Unicode de cette fonction. Le paramètre AddressString est défini sur le type de données PWSTR.

Lorsque unicode et _UNICODE ne sont pas définis, RtlIpv6AddressToStringEx est défini sur RtlIpv6AddressToStringExA, la version ANSI de cette fonction. Le paramètre AddressString est défini sur le type de données PSTR.

La structure IN6_ADDR est définie dans le fichier d’en-tête In6addr.h .

Spécifications

Voir aussi

GetModuleHandle

GetProcAddress

InetNtop

InetPton

LoadLibrary

RtlIpv4AddressToString

RtlIpv4AddressToStringEx

RtlIpv4StringToAddress

RtlIpv4StringToAddressEx

RtlIpv6AddressToString

RtlIpv6StringToAddress

RtlIpv6StringToAddressEx

inet_addr

inet_ntoa