Fonction ParseNetworkString (iphlpapi.h)

La fonction ParseNetworkString analyse la chaîne de réseau d’entrée et vérifie s’il s’agit d’une représentation légale du type de chaîne de réseau IP spécifié. Si la chaîne correspond à un type et à sa spécification, la fonction peut éventuellement retourner le résultat analysé.

Syntaxe

IPHLPAPI_DLL_LINKAGE DWORD ParseNetworkString(
  [in]            const WCHAR       *NetworkString,
  [in]            DWORD             Types,
  [out, optional] PNET_ADDRESS_INFO AddressInfo,
  [out, optional] USHORT            *PortNumber,
  [out, optional] BYTE              *PrefixLength
);

Paramètres

[in] NetworkString

Pointeur vers la chaîne réseau terminée par NULL à analyser.

[in] Types

Type de chaîne réseau IP à analyser. Ce paramètre se compose de l’un des types de chaînes réseau tels que définis dans le fichier d’en-tête Iphlpapi.h .

[out, optional] AddressInfo

En cas de réussite, la fonction retourne un pointeur vers une structure de NET_ADDRESS_INFO qui contient les informations d’adresse IP analysées si aucun pointeur NULL n’a été passé dans ce paramètre.

[out, optional] PortNumber

En cas de réussite, la fonction retourne un pointeur vers le port réseau analysé dans l’ordre de l’hôte si aucun pointeur NULL n’a été passé dans ce paramètre. Si aucun port réseau n’était présent dans le paramètre NetworkString , un pointeur vers une valeur zéro est retourné.

[out, optional] PrefixLength

En cas de réussite, la fonction retourne un pointeur vers la longueur de préfixe analysée si aucun pointeur NULL n’a été passé dans ce paramètre. Si aucun préfixe n’était présent dans le paramètre NetworkString , un pointeur vers une valeur de -1 est retourné.

Valeur retournée

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

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

Notes

La fonction ParseNetworkString analyse la chaîne de réseau d’entrée passée dans le paramètre NetworkString et vérifie s’il s’agit d’une représentation légale de l’un des types de chaînes spécifiés dans l’argument Types . Si la chaîne correspond à un type et à sa spécification, la fonction réussit et peut éventuellement retourner le résultat analysé à l’appelant dans les paramètres facultatifs AddressInfo, PortNumber et PrefixLength lorsque ces paramètres ne sont pas des pointeurs NULL .

La fonction ParseNetworkString peut analyser des représentations d’adresses, de services et de réseaux IPv4 ou IPv6, ainsi que d’adresses Internet et de services nommés à l’aide de noms DNS.

Structure NET_ADDRESS_INFO pointée vers le paramètre AddressInfo . Les structures SOCKADDR_IN et SOCKADDR sont définies dans le fichier d’en-tête Ws2def.h qui est automatiquement inclus par le fichier d’en-tête Winsock2.h . La structure SOCKADDR_IN6 est définie dans le fichier d’en-tête Ws2ipdef.h qui est automatiquement inclus par le fichier d’en-tête Ws2tcpip.h . Pour utiliser la fonction ParseNetworkString et la structure NET_ADDRESS_INFO , les fichiers d’en-tête Winsock2.h et Ws2tcpip.h doivent être inclus avant le fichier d’en-tête Iphlpapi.h .

Configuration requise

Voir aussi

NET_ADDRESS_FORMAT

NET_ADDRESS_INFO

SOCKADDR

SOCKADDR_IN

SOCKADDR_IN6