Function openthread_sys::otThreadGetChildInfoByIndex

source ·

pub unsafe extern "C" fn otThreadGetChildInfoByIndex(
    aInstance: *mut otInstance,
    aChildIndex: u16,
    aChildInfo: *mut otChildInfo
) -> otError

Expand description

The function retains diagnostic information for an attached Child by the internal table index.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aChildIndex The table index. @param[out] aChildInfo A pointer to where the child information is placed.

@retval OT_ERROR_NONE @p aChildInfo was successfully updated with the info for the given index. @retval OT_ERROR_NOT_FOUND No valid child at this index. @retval OT_ERROR_INVALID_ARGS Either @p aChildInfo is NULL, or @p aChildIndex is out of range (higher than max table index).

@sa otGetMaxAllowedChildren