Structure provided in the MGMT_EVT_OP_SETTINGS_MGMT_ACCESS notification callback. More...

#include <zephyr/mgmt/mcumgr/grp/settings_mgmt/settings_mgmt_callbacks.h>

Data Fields
enum settings_mgmt_access_types	access
	Type of access.
char *	name
	Key name for accesses (only set for SETTINGS_ACCESS_READ, SETTINGS_ACCESS_WRITE, SETTINGS_ACCESS_DELETE and SETTINGS_ACCESS_SAVE).
const uint8_t *	val
	Data provided by the user (only set for SETTINGS_ACCESS_WRITE and SETTINGS_ACCESS_SAVE)
const size_t *	val_length
	Length of data provided by the user (only set for SETTINGS_ACCESS_WRITE and SETTINGS_ACCESS_SAVE)

Detailed Description

Structure provided in the MGMT_EVT_OP_SETTINGS_MGMT_ACCESS notification callback.

This callback function is used to notify the application about a pending setting read/write/delete/load/save/commit request and to authorise or deny it. Access will be allowed so long as no handlers return an error, if one returns an error then access will be denied.

Field Documentation

◆ access

enum settings_mgmt_access_types settings_mgmt_access::access

Type of access.

◆ name

char* settings_mgmt_access::name

Key name for accesses (only set for SETTINGS_ACCESS_READ, SETTINGS_ACCESS_WRITE, SETTINGS_ACCESS_DELETE and SETTINGS_ACCESS_SAVE).

Note that this can be changed by handlers to redirect settings access if needed (as long as it does not exceed the maximum setting string size) if CONFIG_MCUMGR_GRP_SETTINGS_BUFFER_TYPE_STACK is selected, of maximum size CONFIG_MCUMGR_GRP_SETTINGS_NAME_LEN.

Note: This string must be NULL terminated.

◆ val

const uint8_t* settings_mgmt_access::val

Data provided by the user (only set for SETTINGS_ACCESS_WRITE and SETTINGS_ACCESS_SAVE)

◆ val_length

const size_t* settings_mgmt_access::val_length

Length of data provided by the user (only set for SETTINGS_ACCESS_WRITE and SETTINGS_ACCESS_SAVE)

The documentation for this struct was generated from the following file:

zephyr/mgmt/mcumgr/grp/settings_mgmt/settings_mgmt_callbacks.h