ot::Srp::Client::SetHostName() method

Sets the host name label. After a successful call to this method, `Callback` will be called to report the status of host info registration with SRP server. The host name can be set before client is started or after start but before host info is registered with server (host info should be in either `kToAdd` or `kRemoved`).

Syntax

Show:

Summary

Declaration

Definition

from srp_client.hpp:522

Error SetHostName(const char *aName);

Implemented in srp_client.cpp:591

Arguments

Argument

Description

aName

A pointer to host name label string (MUST NOT be NULL). Pointer the string buffer MUST persist and remain valid and constant after return from this method.

Return value

kErrorNone The host name label was set successfully. kErrorInvalidArgs The @p aName is NULL. kErrorInvalidState The host name is already set and registered with the server.

Examples

References

from examples

ot::Srp::Client::SetHostName() method

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle