Skip to content

Commit 61d6ca4

Browse files
rghaddabcarlescufi
authored andcommitted
[nrf fromlist] doc: settings: new API functions
Add references to the new API functions that were added "csi_load_one" and "csi_get_val_len" Upstream PR #: 87792 Signed-off-by: Riadh Ghaddab <[email protected]> (cherry picked from commit b26ed3a3ec5dae5017ecd4e40164e3b38ca88235) (cherry picked from commit 85ea893)
1 parent 5b7311d commit 61d6ca4

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

doc/services/settings/index.rst

+14
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,14 @@ backend.
7878
This gets called when loading values from persistent storage using
7979
:c:func:`settings_load()`.
8080

81+
**csi_load_one**
82+
This gets called when loading only one item from persistent storage using
83+
:c:func:`settings_load_one()`.
84+
85+
**csi_get_val_len**
86+
This gets called when getting a value's length from persistent storage using
87+
:c:func:`settings_get_val_len()`.
88+
8189
**csi_save**
8290
This gets called when saving a single setting to persistent storage using
8391
:c:func:`settings_save_one()`.
@@ -148,6 +156,12 @@ After all data is loaded, the ``h_commit`` handler is issued,
148156
signalling the application that the settings were successfully
149157
retrieved.
150158

159+
Alternatively, a call to :c:func:`settings_load_one()` will load only one
160+
Settings entry and store it in the provided buffer.
161+
162+
To get the value's length associated with the Settings entry, a call to
163+
:c:func:`settings_get_val_len()` should be performed
164+
151165
Technically FCB and file backends may store some history of the entities.
152166
This means that the newest data entity is stored after any
153167
older existing data entities.

0 commit comments

Comments
 (0)