GetUdpTable-Funktion (iphlpapi.h)

Artikel
08/24/2023

Die GetUdpTable-Funktion ruft die UDP-Listenertabelle (IPv4 User Datagram Protocol) ab.

Syntax

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

Parameter

[out] UdpTable

Ein Zeiger auf einen Puffer, der die IPv4 UDP-Listenertabelle als MIB_UDPTABLE Struktur empfängt.

[in, out] SizePointer

Gibt bei der Eingabe die Größe des Puffers in Bytes an, auf den der UdpTable-Parameter verweist.

Wenn der Puffer bei der Ausgabe nicht groß genug ist, um die zurückgegebene Listenertabelle zu enthalten, legt die Funktion diesen Parameter auf die erforderliche Puffergröße in Bytes fest.

Im Windows SDK, das für Windows Vista und höher veröffentlicht wurde, wird der Datentyp für diesen Parameter in einen PULONG-Wert geändert, der einem PDWORD entspricht.

[in] Order

Ein boolescher Wert, der angibt, ob die zurückgegebene UDP-Listenertabelle sortiert werden soll. Wenn dieser Parameter TRUE ist, wird die Tabelle in der Folgenden Reihenfolge sortiert:

Lokale IP-Adresse
Lokaler Port

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Rückgabecode	Beschreibung
ERROR_INSUFFICIENT_BUFFER	Der Puffer, auf den der pUdpTable-Parameter verweist, ist nicht groß genug. Die erforderliche Größe wird in der ULONG-Variablen zurückgegeben, auf die der pdwSize-Parameter verweist. Dieser Fehler wird auch zurückgegeben, wenn der pUdpTable-ParameterNULL ist.
ERROR_INVALID_PARAMETER	Der pdwSize-Parameter ist NULL, oder GetUdpTable kann nicht in den Arbeitsspeicher schreiben, auf den der pdwSize-Parameter verweist.
ERROR_NOT_SUPPORTED	Diese Funktion wird auf dem Betriebssystem, das auf dem lokalen System verwendet wird, nicht unterstützt.
Andere	Verwenden Sie FormatMessage , um die Nachrichtenzeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Im Windows SDK, das für Windows Vista und höher veröffentlicht wurde, wird der Rückgabewert der GetUdpTable-Funktion in einen Datentyp von ULONG geändert, der einem DWORD entspricht.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	iphlpapi.h
Bibliothek	Iphlpapi.lib
DLL	Iphlpapi.dll