PixelKey
NeoPixel USB Key
Loading...
Searching...
No Matches
config_api_t Struct Reference

Configuration instance API. More...

#include <config.h>

Data Fields

pixelkey_error_t(* write )(config_data_t const *const p_config_data)
 Writes a configuration data struct to NV memory. More...
 
pixelkey_error_t(* read )(config_data_t **pp_config_data)
 Gets a pointer to the configuration data struct. More...
 

Detailed Description

Configuration instance API.

Field Documentation

◆ read

pixelkey_error_t(* config_api_t::read) (config_data_t **pp_config_data)

Gets a pointer to the configuration data struct.

Parameters
[out]pp_config_dataPointer to write the config data pointer.
Return values
PIXELKEY_ERROR_NONERead was successful.
PIXELKEY_ERROR_NV_MEMORY_ERRORNV memory error occurred on read.

◆ write

pixelkey_error_t(* config_api_t::write) (config_data_t const *const p_config_data)

Writes a configuration data struct to NV memory.

Parameters
[in]p_config_dataPointer to the data to save.
Return values
PIXELKEY_ERROR_NONEWrite was successful.
PIXELKEY_ERROR_NV_MEMORY_ERRORNV memory error occurred on write.

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