Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

API for runtime settings. More...

Functions

int settings_runtime_set (const char *name, const void *data, size_t len)
 Set a value with a specific key to a module handler.
 
int settings_runtime_get (const char *name, void *data, size_t len)
 Get a value corresponding to a key from a module handler.
 
int settings_runtime_commit (const char *name)
 Apply settings in a module handler.
 

Detailed Description

API for runtime settings.

Function Documentation

◆ settings_runtime_commit()

int settings_runtime_commit ( const char *  name)

#include <zephyr/settings/settings.h>

Apply settings in a module handler.

Parameters
nameKey in string format.
Returns
0 on success, non-zero on failure.

◆ settings_runtime_get()

int settings_runtime_get ( const char *  name,
void *  data,
size_t  len 
)

#include <zephyr/settings/settings.h>

Get a value corresponding to a key from a module handler.

Parameters
nameKey in string format.
dataReturned binary value.
lenrequested value length in bytes.
Returns
length of data read on success, negative on failure.

◆ settings_runtime_set()

int settings_runtime_set ( const char *  name,
const void *  data,
size_t  len 
)

#include <zephyr/settings/settings.h>

Set a value with a specific key to a module handler.

Parameters
nameKey in string format.
dataBinary value.
lenValue length in bytes.
Returns
0 on success, non-zero on failure.