Skip to content

Added isKey documentation for the Preferences library #9142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 19, 2024
Merged

Added isKey documentation for the Preferences library #9142

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00a7485
Added isKey and getType methods to the documentation (#9111)
Viproz Jan 16, 2024
96446e0
Removed duplicated getType documentation.
Viproz Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/source/api/preferences.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,27 @@ 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.


``putChar, putUChar``
Expand Down