Mercurial > hg > ucx / file diff

--- a/docs/Writerside/topics/kv_list.h.md	Wed Sep 24 23:52:36 2025 +0200
+++ b/docs/Writerside/topics/kv_list.h.md	Thu Sep 25 14:30:28 2025 +0200
@@ -58,6 +58,8 @@
 
 int cxKvListRemoveKey(CxList *list, size_t index);
 
+const CxHashKey *cxKvListGetKey(CxList *list, size_t index);
+
 int cxKvListAdd(CxList *list, KeyType key, void *value);
 
 int cxKvListInsert(CxList *list, size_t index,
@@ -73,6 +75,8 @@
 They return zero on success and non-zero on failure.
 A failure can happen when the index is out of bounds or when a memory allocation failed.
 The `cxKvListSetKey()` function also returns non-zero if the key already exists for _another_ element.
+With `cxKvListGetKey()`, you can retrieve the key of an element.
+This function returns `NULL` when an element has no key assigned or the index is out of bounds.
 
 With the `cxKvListAdd()` and `cxKvListInsert()` functions, you can add a new element to the list and immediately assign a key to it.
 The `cxKvListAdd()` function will add the element at the end of the list,