Zephyr Project API 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
settings_mgmt.h File Reference

Go to the source code of this file.

Macros

#define SETTINGS_MGMT_ID_READ_WRITE   0
 Command IDs for settings management group.
 
#define SETTINGS_MGMT_ID_DELETE   1
 
#define SETTINGS_MGMT_ID_COMMIT   2
 
#define SETTINGS_MGMT_ID_LOAD_SAVE   3
 

Enumerations

enum  settings_mgmt_ret_code_t {
  SETTINGS_MGMT_ERR_OK = 0 , SETTINGS_MGMT_ERR_UNKNOWN , SETTINGS_MGMT_ERR_KEY_TOO_LONG , SETTINGS_MGMT_ERR_KEY_NOT_FOUND ,
  SETTINGS_MGMT_ERR_READ_NOT_SUPPORTED , SETTINGS_MGMT_ERR_ROOT_KEY_NOT_FOUND , SETTINGS_MGMT_ERR_WRITE_NOT_SUPPORTED , SETTINGS_MGMT_ERR_DELETE_NOT_SUPPORTED
}
 Command result codes for settings management group. More...
 

Macro Definition Documentation

◆ SETTINGS_MGMT_ID_COMMIT

#define SETTINGS_MGMT_ID_COMMIT   2

◆ SETTINGS_MGMT_ID_DELETE

#define SETTINGS_MGMT_ID_DELETE   1

◆ SETTINGS_MGMT_ID_LOAD_SAVE

#define SETTINGS_MGMT_ID_LOAD_SAVE   3

◆ SETTINGS_MGMT_ID_READ_WRITE

#define SETTINGS_MGMT_ID_READ_WRITE   0

Command IDs for settings management group.

Enumeration Type Documentation

◆ settings_mgmt_ret_code_t

Command result codes for settings management group.

Enumerator
SETTINGS_MGMT_ERR_OK 

No error, this is implied if there is no ret value in the response.

SETTINGS_MGMT_ERR_UNKNOWN 

Unknown error occurred.

SETTINGS_MGMT_ERR_KEY_TOO_LONG 

The provided key name is too long to be used.

SETTINGS_MGMT_ERR_KEY_NOT_FOUND 

The provided key name does not exist.

SETTINGS_MGMT_ERR_READ_NOT_SUPPORTED 

The provided key name does not support being read.

SETTINGS_MGMT_ERR_ROOT_KEY_NOT_FOUND 

The provided root key name does not exist.

SETTINGS_MGMT_ERR_WRITE_NOT_SUPPORTED 

The provided key name does not support being written.

SETTINGS_MGMT_ERR_DELETE_NOT_SUPPORTED 

The provided key name does not support being deleted.