Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 7c344cc

Browse filesBrowse files
authored
Added isKey documentation for the Preferences library (espressif#9142)
* Added isKey and getType methods to the documentation (espressif#9111) * Removed duplicated getType documentation.
1 parent 5bf60b7 commit 7c344cc
Copy full SHA for 7c344cc

File tree

Expand file treeCollapse file tree

1 file changed

+21
-0
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+21
-0
lines changed

‎docs/source/api/preferences.rst

Copy file name to clipboardExpand all lines: docs/source/api/preferences.rst
+21Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,27 @@ Arduino-esp32 Preferences API
177177

178178
**Note**
179179
* A message providing the reason for a failed call is sent to the arduino-esp32 ``log_e`` facility.
180+
181+
182+
``isKey``
183+
*************
184+
185+
Check if a key-value pair from the currently open namespace exists.
186+
187+
.. code-block:: arduino
188+
189+
bool isKey(const char * key)
190+
..
191+
192+
**Parameters**
193+
* ``key`` (Required)
194+
- the name of the key to be checked.
195+
196+
**Returns**
197+
* ``true`` if key-value pair exists; ``false`` otherwise.
198+
199+
**Note**
200+
* Attempting to check a key without a namespace being open will return false.
180201

181202

182203
``putChar, putUChar``

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.