名称

Preferences::getChar()
Preferences::getUChar()
Preferences::getShort()
Preferences::getUShort()
Preferences::getInt()
Preferences::getUInt()
Preferences::getLong()
Preferences::getULong()
Preferences::getLong64()
Preferences::getULong64()
Preferences::getFloat()
Preferences::getDouble()
Preferences::getBool()
Preferences::getString()

説明

NVS(Non-volatile storage)から、現在利用中のネームスペース内の指定したキーに対応する値を取得する。

書式

#include <Preferences.h>

int8_t Preferences::getChar(const char* key, const int8_t defaultValue);
uint8_t Preferences::getUChar(const char* key, const uint8_t defaultValue);
int16_t Preferences::getShort(const char* key, const int16_t defaultValue);
uint16_t Preferences::getUShort(const char* key, const uint16_t defaultValue);
int32_t Preferences::getInt(const char* key, const int32_t defaultValue);
uint32_t Preferences::getUInt(const char* key, const uint32_t defaultValue);
int32_t Preferences::getLong(const char* key, const int32_t defaultValue);
uint32_t Preferences::getULong(const char* key, const uint32_t defaultValue);
int64_t Preferences::getLong64(const char* key, const int64_t defaultValue);
uint64_t Preferences::getULong64(const char* key, const uint64_t defaultValue);
float_t Preferences::getFloat(const char* key, const float_t defaultValue);
double_t Preferences::getDouble(const char* key, const double_t defaultValue);
bool Preferences::getBool(const char* key, const bool defaultValue);
size_t Preferences::getString(const char* key, char* value, const size_t maxLen);
String Preferences::getString(const char* key, const String defaultValue);
size_t Preferences::getBytesLength(const char* key);
size_t Preferences::getBytes(const char* key, void * buf, size_t maxLen) ;

引数

戻り値

戻り値の型がsize_t以外の場合：

読み出しに成功した場合は、指定したキーに対応する値。失敗した場合は、defaultValueで指定した値。

戻り値の型がsize_tの場合：

文字列長。読み出しに失敗した場合は0。

注意

エラー時にはdefaultValueが返されるため、実際にエラーが発生したかどうかをプログラムで確認する手段はない。エラーレベルのログは出力される。

使用例

• StartCounter

バージョン

最終更新日

September 4, 2022