openthread_sys

Function otPlatSettingsDelete

Source
pub unsafe extern "C" fn otPlatSettingsDelete(
    aInstance: *mut otInstance,
    aKey: u16,
    aIndex: c_int,
) -> otError
Expand description

Removes a setting from the setting store.

Deletes a specific value from the setting identified by aKey from the settings store.

Note that the underlying implementation is not required to maintain the order of the items associated with a specific key.

@param[in] aInstance The OpenThread instance structure. @param[in] aKey The key associated with the requested setting. @param[in] aIndex The index of the value to be removed. If set to -1, all values for this @p aKey will be removed.

@retval OT_ERROR_NONE The given key and index was found and removed successfully. @retval OT_ERROR_NOT_FOUND The given key or index was not found in the setting store. @retval OT_ERROR_NOT_IMPLEMENTED This function is not implemented on this platform.