Jump to main content

##

# TCPIP_Helper_StringToIPv6Address Function

## C

    bool TCPIP_Helper_StringToIPv6Address(
        const char * str,
        IPV6_ADDR * addr
    );

## Description

This function parses the text representation of an IPv6 address to an IPV6_ADDR struct. The output result is big-endian.

## Preconditions

addr - valid pointer to an IPV6 address.

## Parameters

Parameters | Description
--- | ---
str | Pointer to an RFC3513, Section 2.2 text representation of an IPv6 address.

## Returns

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

## Remarks

1111:2222:3333:4444:5555:6666:AAAA:FFFF 1111:2222::FFFF 1111:2222:3333:4444:5555:6666:192.168.1.20 addr - Pointer to IPV6_ADDR in which to store the result.