otMeshDiagGetNextChildInfo() function

Iterates through the discovered children of a router. This function MUST be used from the callback `otMeshDiagDiscoverCallback()` and use the `mChildIterator` from the `aRouterInfo` struct that is provided as input to the callback.

Syntax

Show:

Summary

Declaration

Definition

from mesh_diag.h:215

otError otMeshDiagGetNextChildInfo(otMeshDiagChildIterator *aIterator, otMeshDiagChildInfo *aChildInfo);

Implemented in mesh_diag_api.cpp:58

Arguments

Argument

Description

aIterator

The address iterator to use.

aChildInfo

A pointer to return the child info (if any).

Return value

OT_ERROR_NONE Successfully retrieved the next child. @p aChildInfo and @p aIterator are updated. OT_ERROR_NOT_FOUND No more child. Reached the end of the list.

Examples

References

from examples

otMeshDiagGetNextChildInfo() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle