Skip to content

Commit

Permalink
Added isKey and getType methods to the documentation (#9111)
Browse files Browse the repository at this point in the history
  • Loading branch information
Viproz authored Jan 16, 2024
1 parent 429a72b commit da6325d
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/en/api/preferences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``
Expand Down

0 comments on commit da6325d

Please sign in to comment.