RtlIpv4AddressToStringExW-Funktion (ip2string.h)

Artikel
02/28/2024

Die RtlIpv4AddressToStringEx-Funktion konvertiert eine IPv4-Adresse und eine Portnummer in eine Zeichenfolge im Internetstandardformat.

Syntax

NTSYSAPI NTSTATUS RtlIpv4AddressToStringExW(
  [in]      const in_addr *Address,
  [in]      USHORT        Port,
  [out]     PWSTR         AddressString,
  [in, out] PULONG        AddressStringLength
);

Parameter

[in] Address

Die IPv4-Adresse in Netzwerkbytereihenfolge.

[in] Port

Die Portnummer im Format der Netzwerkbytereihenfolge. Dieser Parameter ist optional.

[out] AddressString

Ein Zeiger auf den Puffer, um die NULL-endende Zeichenfolgendarstellung der IPv4-Adresse und des Ports zu empfangen. Dieser Puffer sollte groß genug sein, um mindestens INET_ADDRSTRLEN Zeichen aufzunehmen. Der INET_ADDRSTRLEN Wert wird in der Ws2ipdef.h-Headerdatei definiert.

[in, out] AddressStringLength

Bei der Eingabe die Anzahl der Zeichen, die in den Puffer passen, auf die der AddressString-Parameter verweist, einschließlich des NULL-Abschlusszeichens. Bei der Ausgabe enthält dieser Parameter die Anzahl der Zeichen, die tatsächlich in den Puffer geschrieben werden, auf den der AddressString-Parameter verweist.

Rückgabewert

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

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

Rückgabecode	Beschreibung
STATUS_INVALID_PARAMETER	Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im AddressString - oder AddressStringLength-Parameter übergeben wird. Dieser Fehler wird auch zurückgegeben, wenn die Länge des Puffers, auf den der AddressString-Parameter verweist, nicht groß genug ist, um die Zeichenfolgendarstellung der IPv4-Adresse und des IPv4-Ports zu empfangen.
Andere	Verwenden Sie FormatMessage , um die Meldungszeichenfolge für den zurückgegebenen Fehler abzurufen.

Rückgabecode

Beschreibung

STATUS_INVALID_PARAMETER

Es wurde ein ungültiger Parameter an die Funktion übergeben. Dieser Fehler wird zurückgegeben, wenn ein NULL-Zeiger im AddressString - oder AddressStringLength-Parameter übergeben wird. Dieser Fehler wird auch zurückgegeben, wenn die Länge des Puffers, auf den der AddressString-Parameter verweist, nicht groß genug ist, um die Zeichenfolgendarstellung der IPv4-Adresse und des IPv4-Ports zu empfangen.

Andere

Verwenden Sie FormatMessage , um die Meldungszeichenfolge für den zurückgegebenen Fehler abzurufen.

Hinweise

Die RtlIpv4AddressToStringEx-Funktion wird verwendet, um eine IPv4-Adresse und eine Portnummer in die Zeichenfolgendarstellung der IPv4-Adresse im Internet-Dotted-Decimal-Format zu konvertieren, gefolgt von einem Doppelpunkt und einer Zeichenfolgendarstellung des Ports.

RtlIpv4AddressToStringEx ist eine Komfortfunktion, die nicht erfordert, dass die Windows Sockets-DLL geladen werden muss, um auf eine funktion zuzugreifen, die in Windows Sockets bereitgestellt wird, um die Konvertierung von IP-Adressen in Zeichenfolgen durchzuführen.

Wenn die Länge des Puffers, auf den der AddressString-Parameter verweist, nicht groß genug ist, um die Zeichenfolgendarstellung der IPv4-Adresse und des Ports zu empfangen, gibt RtlIpv4AddressToStringExERROR_INVALID_PARAMETER zurück und legt den AddressStringLength-Parameter auf die erforderliche Pufferlänge fest.

Wenn entweder UNICODE oder _UNICODE definiert ist, wird RtlIpv4AddressToStringEx für RtlIpv4AddressToStringExW, die Unicode-Version dieser Funktion, definiert. Der AddressString-Parameter ist für den PWSTR-Datentyp definiert.

Wenn sowohl UNICODE als auch _UNICODE nicht definiert sind, wird RtlIpv4AddressToStringEx für RtlIpv4AddressToStringExA, die ANSI-Version dieser Funktion, definiert. Der AddressString-Parameter ist für den PSTR-Datentyp definiert.

Die IN_ADDR-Struktur ist in der Headerdatei Inaddr.h definiert.

Eine Importbibliothek, die die RtlIpv4AddressToStringEx-Funktion enthält, ist in der für Windows Vista veröffentlichten Microsoft Windows Software Development Kit (SDK) nicht enthalten. Die RtlIpv4AddressToStringEx-Funktion ist in der Ntdll.lib-Importbibliothek enthalten, die im Windows Driver Kit (WDK) enthalten ist. Eine Anwendung kann auch die Funktionen GetModuleHandle und GetProcAddress verwenden, um den Funktionszeiger aus dem Ntdll.dll abzurufen und diese Funktion aufzurufen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	ip2string.h (include Mstcpip.h)
Bibliothek	ntdll.lib
DLL	ntdll.dll