GetUdpTable, fonction (iphlpapi.h)

Article
08/24/2023

La fonction GetUdpTable récupère la table d’écouteur UDP (User Datagram Protocol) IPv4.

Syntaxe

IPHLPAPI_DLL_LINKAGE ULONG GetUdpTable(
  [out]     PMIB_UDPTABLE UdpTable,
  [in, out] PULONG        SizePointer,
  [in]      BOOL          Order
);

Paramètres

[out] UdpTable

Pointeur vers une mémoire tampon qui reçoit la table d’écouteur UDP IPv4 en tant que structure de MIB_UDPTABLE .

[in, out] SizePointer

Lors de l’entrée, spécifie la taille en octets de la mémoire tampon pointée vers le paramètre UdpTable .

En sortie, si la mémoire tampon n’est pas suffisamment grande pour contenir la table d’écouteurs retournée, la fonction définit ce paramètre sur la taille de mémoire tampon requise en octets.

Sur le Kit de développement logiciel (SDK) Windows publié pour Windows Vista et versions ultérieures, le type de données de ce paramètre est remplacé par un PULONG équivalent à un PDWORD.

[in] Order

Valeur booléenne qui spécifie si la table d’écouteur UDP retournée doit être triée. Si ce paramètre a la valeur TRUE, la table est triée dans l’ordre de :

Adresse IP locale
Port local

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_INSUFFICIENT_BUFFER	La mémoire tampon pointée par le paramètre pUdpTable n’est pas assez grande. La taille requise est retournée dans la variable ULONG pointée vers par le paramètre pdwSize . Cette erreur est également retournée si le paramètre pUdpTable a la valeur NULL.
ERROR_INVALID_PARAMETER	Le paramètre pdwSize a la valeur NULL ou GetUdpTable ne peut pas écrire dans la mémoire pointée par le paramètre pdwSize .
ERROR_NOT_SUPPORTED	Cette fonction n’est pas prise en charge sur le système d’exploitation utilisé sur le système local.
Autres	Utilisez FormatMessage pour obtenir la chaîne de message de l’erreur retournée.

Notes

Sur le Kit de développement logiciel (SDK) Windows publié pour Windows Vista et versions ultérieures, la valeur de retour de la fonction GetUdpTable est remplacée par un type de données ULONG équivalent à un DWORD.

Configuration requise


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	iphlpapi.h
Bibliothèque	Iphlpapi.lib
DLL	Iphlpapi.dll