Symbols

loading...

Files

loading...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFot::SettingsDriver::Get() const

ot::SettingsDriver::Get() const method

Fetches the value identified by @p aKey at a given @p aIndex.

Syntax

Show:

Summary

Declaration

from settings_driver.hpp:155

Error Get(uint16_t aKey, int aIndex, void *aValue, uint16_t *aValueLength) const;

Arguments

Argument

Description

aKey

The key associated with the requested value.

aIndex

The index of the specific item to get.

aValue

A pointer to where the value of the setting should be written. May be `nullptr` if just testing for the presence or length of a key.

aValueLength

A pointer to the length of the value. When called, this should point to an integer containing the maximum bytes that can be written to @p aValue. At return, the actual length of the setting is written. May be `nullptr` if performing a presence check.

Return value

kErrorNone The value was fetched successfully. kErrorNotFound The key was not found.

References

Code

Location

Scope

Referrer

Error Get(uint16_t aKey, int aIndex, void *aValue, uint16_t *aValueLength) const

settings_driver.hpp:155

Error Get(uint16_t aKey, void *aValue, uint16_t *aValueLength) const { return Get(aKey, 0, aValue, aValueLength); }

settings_driver.hpp:183

ot::SettingsDriver

ot::SettingsDriver::Get() const

Call Tree

ot::SettingsDriver::Get() const is called by 1 function and calls 3 functions:

ot::SettingsDriver::Get() const

ot::SettingsDriver::Get() const

ot::SettingsDriver::GetInstancePtr() const

otPlatSettingsGet()

ot::SettingsDriver::Get() const

Data Use

ot::SettingsDriver::Get() const:

ot::SettingsDriver::Get() const

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Lifecycle

All items filtered out

All items filtered out