Class IPreferences

ClassList > IPreferences

Public Functions

Type	Name
	IPreferences ()
bool	begin (const char * name, bool readOnly=false, const char * partition_label=NULL)
bool	clear ()
void	end ()
size_t	freeEntries ()
bool	getBool (const char * key, bool defaultValue=false)
size_t	getBytes (const char * key, void * buf, size_t maxLen)
size_t	getBytesLength (const char * key)
int8_t	getChar (const char * key, int8_t defaultValue=0)
double_t	getDouble (const char * key, double_t defaultValue=NAN)
float_t	getFloat (const char * key, float_t defaultValue=NAN)
int32_t	getInt (const char * key, int32_t defaultValue=0)
int32_t	getLong (const char * key, int32_t defaultValue=0)
int64_t	getLong64 (const char * key, int64_t defaultValue=0)
int16_t	getShort (const char * key, int16_t defaultValue=0)
size_t	getString (const char * key, char * value, size_t maxLen)
String	getString (const char * key, String defaultValue=String())
PreferenceType	getType (const char * key)
uint8_t	getUChar (const char * key, uint8_t defaultValue=0)
uint32_t	getUInt (const char * key, uint32_t defaultValue=0)
uint32_t	getULong (const char * key, uint32_t defaultValue=0)
uint64_t	getULong64 (const char * key, uint64_t defaultValue=0)
uint16_t	getUShort (const char * key, uint16_t defaultValue=0)
bool	isKey (const char * key)
size_t	putBool (const char * key, bool value)
size_t	putBytes (const char * key, const void * value, size_t len)
size_t	putChar (const char * key, int8_t value)
size_t	putDouble (const char * key, double_t value)
size_t	putFloat (const char * key, float_t value)
size_t	putInt (const char * key, int32_t value)
size_t	putLong (const char * key, int32_t value)
size_t	putLong64 (const char * key, int64_t value)
size_t	putShort (const char * key, int16_t value)
size_t	putString (const char * key, const char * value)
size_t	putString (const char * key, String value)
size_t	putUChar (const char * key, uint8_t value)
size_t	putUInt (const char * key, uint32_t value)
size_t	putULong (const char * key, uint32_t value)
size_t	putULong64 (const char * key, uint64_t value)
size_t	putUShort (const char * key, uint16_t value)
bool	remove (const char * key)
	~IPreferences ()

Public Functions Documentation

function IPreferences

inline IPreferences::IPreferences () 

function begin

bool IPreferences::begin (
    const char * name,
    bool readOnly=false,
    const char * partition_label=NULL
) 

function clear

bool IPreferences::clear () 

function end

void IPreferences::end () 

function freeEntries

size_t IPreferences::freeEntries () 

function getBool

bool IPreferences::getBool (
    const char * key,
    bool defaultValue=false
) 

function getBytes

size_t IPreferences::getBytes (
    const char * key,
    void * buf,
    size_t maxLen
) 

function getBytesLength

size_t IPreferences::getBytesLength (
    const char * key
) 

function getChar

int8_t IPreferences::getChar (
    const char * key,
    int8_t defaultValue=0
) 

function getDouble

double_t IPreferences::getDouble (
    const char * key,
    double_t defaultValue=NAN
) 

function getFloat

float_t IPreferences::getFloat (
    const char * key,
    float_t defaultValue=NAN
) 

function getInt

int32_t IPreferences::getInt (
    const char * key,
    int32_t defaultValue=0
) 

function getLong

int32_t IPreferences::getLong (
    const char * key,
    int32_t defaultValue=0
) 

function getLong64

int64_t IPreferences::getLong64 (
    const char * key,
    int64_t defaultValue=0
) 

function getShort

int16_t IPreferences::getShort (
    const char * key,
    int16_t defaultValue=0
) 

function getString [1/2]

size_t IPreferences::getString (
    const char * key,
    char * value,
    size_t maxLen
) 

function getString [2/2]

String IPreferences::getString (
    const char * key,
    String defaultValue=String()
) 

function getType

PreferenceType IPreferences::getType (
    const char * key
) 

function getUChar

uint8_t IPreferences::getUChar (
    const char * key,
    uint8_t defaultValue=0
) 

function getUInt

uint32_t IPreferences::getUInt (
    const char * key,
    uint32_t defaultValue=0
) 

function getULong

uint32_t IPreferences::getULong (
    const char * key,
    uint32_t defaultValue=0
) 

function getULong64

uint64_t IPreferences::getULong64 (
    const char * key,
    uint64_t defaultValue=0
) 

function getUShort

uint16_t IPreferences::getUShort (
    const char * key,
    uint16_t defaultValue=0
) 

function isKey

bool IPreferences::isKey (
    const char * key
) 

function putBool

size_t IPreferences::putBool (
    const char * key,
    bool value
) 

function putBytes

size_t IPreferences::putBytes (
    const char * key,
    const void * value,
    size_t len
) 

function putChar

size_t IPreferences::putChar (
    const char * key,
    int8_t value
) 

function putDouble

size_t IPreferences::putDouble (
    const char * key,
    double_t value
) 

function putFloat

size_t IPreferences::putFloat (
    const char * key,
    float_t value
) 

function putInt

size_t IPreferences::putInt (
    const char * key,
    int32_t value
) 

function putLong

size_t IPreferences::putLong (
    const char * key,
    int32_t value
) 

function putLong64

size_t IPreferences::putLong64 (
    const char * key,
    int64_t value
) 

function putShort

size_t IPreferences::putShort (
    const char * key,
    int16_t value
) 

function putString [1/2]

size_t IPreferences::putString (
    const char * key,
    const char * value
) 

function putString [2/2]

size_t IPreferences::putString (
    const char * key,
    String value
) 

function putUChar

size_t IPreferences::putUChar (
    const char * key,
    uint8_t value
) 

function putUInt

size_t IPreferences::putUInt (
    const char * key,
    uint32_t value
) 

function putULong

size_t IPreferences::putULong (
    const char * key,
    uint32_t value
) 

function putULong64

size_t IPreferences::putULong64 (
    const char * key,
    uint64_t value
) 

function putUShort

size_t IPreferences::putUShort (
    const char * key,
    uint16_t value
) 

function remove

bool IPreferences::remove (
    const char * key
) 

function ~IPreferences

inline IPreferences::~IPreferences () 

---

The documentation for this class was generated from the following file cores/common/arduino/libraries/common/Preferences/Preferences.h