ot::Dns::Client::BrowseResponse::GetHostAddress() const method

Gets the host IPv6 address from a DNS browse (service instance enumeration) response. MUST only be used from `BrowseCallback`. The response can include zero or more IPv6 address records. @p aIndex can be used to iterate through the list of addresses. Index zero gets the first address and so on. When we reach end of the list, this method returns `kErrorNotFound`.

Syntax

Show:

Summary

Declaration

Definition

from dns_client.hpp:480

Error GetHostAddress(const char *aHostName, uint16_t aIndex, Ip6::Address &aAddress, uint32_t &aTtl) const;

Implemented in dns_client.cpp:497

Arguments

Argument

Description

aHostName

The host name to get the address (MUST NOT be `nullptr`).

aIndex

The address record index to retrieve.

aAddress

A reference to an IPv6 address to output the address.

aTtl

A reference to a `uint32_t` to output TTL for the address.

Return value

kErrorNone The address was read successfully. kErrorNotFound No address record for @p aHostname at @p aIndex. kErrorParse Could not parse the records.