TCPIP_Helper_StringToIPAddress Function

C

bool TCPIP_Helper_StringToIPAddress(
    const char* str, 
    IPV4_ADDR* IPAddress
);

Description

This function parses a dotted-quad decimal IP address string into an IPV4_ADDR struct. The output result is big-endian.

Preconditions

IP Address - a valid pointer to an IPV4_ADDR.

Parameters

ParametersDescription
strPointer to a dotted-quad IP address string.
IPAddressPointer to IPV4_ADDR in which to store the result.

Returns

  • True - An IP address was successfully decoded.

  • False - Pointer to IPV4_ADDR in which to store the result.

Remarks

If str == NULL or strlen(str) == 0, the result will be address 0.