arduino/arduino-esp32
1
0
Fork 0
mirror of https://github.com/espressif/arduino-esp32 synced 2024-09-21 10:28:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added isKey and getType methods to the documentation (#9111)

Browse Source
This commit is contained in:
Vincent 2024-01-16 15:05:47 +01:00 committed by GitHub
parent 429a72b17e
commit da6325dd7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/en/api/preferences.rst
View File

@ -177,6 +177,45 @@ Arduino-esp32 Preferences API
**Note**
* A message providing the reason for a failed call is sent to the arduino-esp32 ``log_e`` facility.
``isKey``
*************
Check if a key-value pair from the currently open namespace exists.
.. code-block:: arduino
bool isKey(const char * key)
..
**Parameters**
* ``key`` (Required)
- the name of the key to be checked.
**Returns**
* ``true`` if key-value pair exists; ``false`` otherwise.
**Note**
* Attempting to check a key without a namespace being open will return false.
``getType``
*************
Returns the type of a key-value pair from the currently open namespace.
.. code-block:: arduino
PreferenceType getType(const char * key)
..
**Parameters**
* ``key`` (Required)
- the name of the key to be checked.
**Returns**
* PreferenceType element contaning the type of the key-value pair or PT_INVALID on error.
``putChar, putUChar``