Zephyr API
4.4.99
A Scalable Open Source RTOS
Toggle main menu visibility
Loading...
Searching...
No Matches
settings_mgmt.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2023 Nordic Semiconductor ASA
3
*
4
* SPDX-License-Identifier: Apache-2.0
5
*/
6
12
13
#ifndef H_SETTINGS_MGMT_
14
#define H_SETTINGS_MGMT_
15
22
23
#ifdef __cplusplus
24
extern
"C"
{
25
#endif
26
31
#define SETTINGS_MGMT_ID_READ_WRITE 0
32
#define SETTINGS_MGMT_ID_DELETE 1
33
#define SETTINGS_MGMT_ID_COMMIT 2
34
#define SETTINGS_MGMT_ID_LOAD_SAVE 3
36
40
enum
settings_mgmt_ret_code_t
{
42
SETTINGS_MGMT_ERR_OK
= 0,
43
45
SETTINGS_MGMT_ERR_UNKNOWN
,
46
48
SETTINGS_MGMT_ERR_KEY_TOO_LONG
,
49
51
SETTINGS_MGMT_ERR_KEY_NOT_FOUND
,
52
54
SETTINGS_MGMT_ERR_READ_NOT_SUPPORTED
,
55
57
SETTINGS_MGMT_ERR_ROOT_KEY_NOT_FOUND
,
58
60
SETTINGS_MGMT_ERR_WRITE_NOT_SUPPORTED
,
61
63
SETTINGS_MGMT_ERR_DELETE_NOT_SUPPORTED
,
64
66
SETTINGS_MGMT_ERR_SAVE_NOT_SUPPORTED
,
67
73
SETTINGS_MGMT_ERR_SAVE_FAILED_VALUE_TOO_LONG_TO_READ
,
74
};
75
76
#ifdef __cplusplus
77
}
78
#endif
79
83
84
#endif
settings_mgmt_ret_code_t
settings_mgmt_ret_code_t
Command result codes for settings management group.
Definition
settings_mgmt.h:40
SETTINGS_MGMT_ERR_WRITE_NOT_SUPPORTED
@ SETTINGS_MGMT_ERR_WRITE_NOT_SUPPORTED
The provided key name does not support being written.
Definition
settings_mgmt.h:60
SETTINGS_MGMT_ERR_SAVE_FAILED_VALUE_TOO_LONG_TO_READ
@ SETTINGS_MGMT_ERR_SAVE_FAILED_VALUE_TOO_LONG_TO_READ
The provided key cannot be saved before the value is longer than the size of the largest value that c...
Definition
settings_mgmt.h:73
SETTINGS_MGMT_ERR_UNKNOWN
@ SETTINGS_MGMT_ERR_UNKNOWN
Unknown error occurred.
Definition
settings_mgmt.h:45
SETTINGS_MGMT_ERR_ROOT_KEY_NOT_FOUND
@ SETTINGS_MGMT_ERR_ROOT_KEY_NOT_FOUND
The provided root key name does not exist.
Definition
settings_mgmt.h:57
SETTINGS_MGMT_ERR_KEY_TOO_LONG
@ SETTINGS_MGMT_ERR_KEY_TOO_LONG
The provided key name is too long to be used.
Definition
settings_mgmt.h:48
SETTINGS_MGMT_ERR_READ_NOT_SUPPORTED
@ SETTINGS_MGMT_ERR_READ_NOT_SUPPORTED
The provided key name does not support being read.
Definition
settings_mgmt.h:54
SETTINGS_MGMT_ERR_DELETE_NOT_SUPPORTED
@ SETTINGS_MGMT_ERR_DELETE_NOT_SUPPORTED
The provided key name does not support being deleted.
Definition
settings_mgmt.h:63
SETTINGS_MGMT_ERR_OK
@ SETTINGS_MGMT_ERR_OK
No error, this is implied if there is no ret value in the response.
Definition
settings_mgmt.h:42
SETTINGS_MGMT_ERR_KEY_NOT_FOUND
@ SETTINGS_MGMT_ERR_KEY_NOT_FOUND
The provided key name does not exist.
Definition
settings_mgmt.h:51
SETTINGS_MGMT_ERR_SAVE_NOT_SUPPORTED
@ SETTINGS_MGMT_ERR_SAVE_NOT_SUPPORTED
The provided key name does not support being saved.
Definition
settings_mgmt.h:66
zephyr
mgmt
mcumgr
grp
settings_mgmt
settings_mgmt.h
Generated on
for Zephyr API by
1.17.0