Skip to content
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.

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

Added isKey and getType methods to Preferences documentation #9111

Merged
merged 1 commit into from
Jan 16, 2024
Merged
Changes from all commits
Commits
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
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
Loading