RtlIpv4AddressToStringEx (Compact 7)
3/12/2014
This function converts an IPv4 address and port number to a string in Internet standard format.
Syntax
LONG NTAPI RtlIpv4AddressToStringEx(
__in const IN_ADDR* Address,
__in USHORT Port,
__out LPTSTR AddressString,
__inout PULONG AddressStringLength
);
Parameters
- Address
The IPv4 address in network byte order.
- Port
The port number in network byte order format. This parameter is optional.
- AddressString
A pointer to the buffer to receive the NULL-terminated string representation of the IPv4 address and port.
- AddressStringLength
On input, the length of the buffer pointed to by the AddressString parameter. On output, this parameter contains the number of characters actually written to the buffer pointed to by the AddressString parameter.
Return Value
| Return code | Description |
|---|---|
NO_ERROR |
The function succeeds. |
ERROR_INVALID_PARAMETER |
An invalid parameter was passed to the function. This error is returned if a NULL pointer is passed in the AddressString or AddressStringLength parameter. This error is also returned if the length of the buffer pointed to by the AddressString parameter is not large enough to receive the string representation of the IPv4 address and port. |
Other |
Use FormatMessage to obtain the message string for the returned error. |
Remarks
The RtlIpv4AddressToStringEx function is used to convert an IPv4 address and port number to the string representation of the IPv4 address in Internet dotted-decimal format followed by a colon character and a string representation of the port.
RtlIpv4AddressToStringEx is a convenience function that does not require that the Windows Sockets DLL be loaded to access a function that is provided in Windows Sockets to perform IP address to string conversion.
If the length of the buffer pointed to by the AddressString parameter is not large enough to receive the string representation of the IPv4 address and port, RtlIpv4AddressToStringEx returns ERROR_INVALID_PARAMETER and sets the AddressStringLength parameter to the buffer length required.
When UNICODE or _UNICODE is defined, RtlIpv4AddressToStringEx is defined to RtlIpv4AddressToStringExW, the Unicode version of this function. The AddressString parameter is defined to the PWSTR data type.
When UNICODE or _UNICODE is not defined, RtlIpv4AddressToStringEx is defined to RtlIpv4AddressToStringExA, the ANSI version of this function. The AddressString parameter is defined to the PSTR data type.
The IN_ADDR structure is defined in the Inaddr.h header file.
See Also
Reference
IP Helper Functions
RtlIpv4AddressToString
RtlIpv4StringToAddress
RtlIpv4StringToAddressEx
RtlIpv6AddressToString
RtlIpv6AddressToStringEx
RtlIpv6StringToAddress
RtlIpv6StringToAddressEx