Function openthread_sys::otBorderAgentSetId

source · 
pub unsafe extern "C" fn otBorderAgentSetId(
    aInstance: *mut otInstance,
    aId: *const otBorderAgentId,
) -> otError
Expand description

Sets the Border Agent ID.

Requires OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE.

The Border Agent ID will be saved in persistent storage and survive reboots. It’s required to set the ID only once after factory reset. If the ID has never been set by calling this function, a random ID will be generated and returned when otBorderAgentGetId is called.

@param[in] aInstance A pointer to an OpenThread instance. @param[out] aId A pointer to the Border Agent ID.

@retval OT_ERROR_NONE If successfully set the Border Agent ID. @retval … If failed to set the Border Agent ID.

@sa otBorderAgentGetId