Function openthread_sys::otThreadSetMaxAllowedChildren

source ·

pub unsafe extern "C" fn otThreadSetMaxAllowedChildren(
    aInstance: *mut otInstance,
    aMaxChildren: u16
) -> otError

Expand description

Sets the maximum number of children currently allowed.

This parameter can only be set when Thread protocol operation has been stopped.

@param[in] aInstance A pointer to an OpenThread instance. @param[in] aMaxChildren The maximum allowed children.

@retval OT_ERROR_NONE Successfully set the max. @retval OT_ERROR_INVALID_ARGS If @p aMaxChildren is not in the range [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN]. @retval OT_ERROR_INVALID_STATE If Thread isn’t stopped.

@sa otThreadGetMaxAllowedChildren