\label{doc_contrib_usecases_api_core_md_md_doc_contrib_usecases_api_core}%
\Hypertarget{doc_contrib_usecases_api_core_md_md_doc_contrib_usecases_api_core}%
 \hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1685}{}\doxysection{Create $<$tt$>$\+Key$<$/tt$>$}\label{doc_contrib_usecases_api_core_md_autotoc_md1685}
This use case is implemented as {\ttfamily \mbox{\hyperlink{group__key_gad23c65b44bf48d773759e1f9a4d43b89}{key\+New()}}}.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1686}{}\doxysection{$<$tt$>$\+Key$<$/tt$>$ Name}\label{doc_contrib_usecases_api_core_md_autotoc_md1686}
The name of a {\ttfamily Key} is stored in two forms\+: escaped and unescaped.

The escaped from can be accessed via {\ttfamily \mbox{\hyperlink{group__keyname_ga8e805c726a60da921d3736cda7813513}{key\+Name()}}} and the unescaped form via {\ttfamily \mbox{\hyperlink{group__keyname_ga6fe6af4c27b35d911a533f4ae4d698bb}{key\+Unescaped\+Name()}}}.

Manipulating the name is possible via the {\ttfamily \mbox{\hyperlink{group__keyname_ga7699091610e7f3f43d2949514a4b35d9}{key\+Set\+Name()}}}, {\ttfamily \mbox{\hyperlink{group__keyname_ga6e804bd453f98c28b0ff51430d1df407}{key\+Set\+Base\+Name()}}}, {\ttfamily \mbox{\hyperlink{group__keyname_gaa70593a2c772c4b7bc33423b9b10a270}{key\+Add\+Name()}}} and {\ttfamily \mbox{\hyperlink{group__keyname_gaa942091fc4bd5c2699e49ddc50829524}{key\+Add\+Base\+Name()}}} functions, which allow various kinds of manipulation.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1687}{}\doxysection{$<$tt$>$\+Key$<$/tt$>$ Namespace}\label{doc_contrib_usecases_api_core_md_autotoc_md1687}
This use case implemented via the {\ttfamily \mbox{\hyperlink{group__keyname_gafc3ca03ed10f87eb59bdc02cf2a0de8d}{key\+Get\+Namespace()}}} and {\ttfamily \mbox{\hyperlink{group__keyname_ga98c1c1307419e689c98e556e5c542073}{key\+Set\+Namespace()}}} functions.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1688}{}\doxysection{$<$tt$>$\+Key$<$/tt$>$ Value}\label{doc_contrib_usecases_api_core_md_autotoc_md1688}
The value of a {\ttfamily Key} can be accessed via {\ttfamily \mbox{\hyperlink{group__keyvalue_ga6f29609c5da53c6dc26a98678d5752af}{key\+Value()}}} and {\ttfamily \mbox{\hyperlink{group__keyvalue_ga880936f2481d28e6e2acbe7486a21d05}{key\+String()}}}. It can be changed via {\ttfamily \mbox{\hyperlink{group__keyvalue_ga622bde1eb0e0c4994728331326340ef2}{key\+Set\+String()}}} and {\ttfamily \mbox{\hyperlink{group__keyvalue_gaa50a5358fd328d373a45f395fa1b99e7}{key\+Set\+Binary()}}}.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1689}{}\doxysection{$<$tt$>$\+Key$<$/tt$>$ Metadata}\label{doc_contrib_usecases_api_core_md_autotoc_md1689}
This use case is implemented as the {\ttfamily \mbox{\hyperlink{group__keymeta_ga11706f1753e67933f7cffc5c0345cd29}{key\+Meta()}}} function.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1690}{}\doxysubsection{$<$tt$>$\+Key$<$/tt$>$ Ordering}\label{doc_contrib_usecases_api_core_md_autotoc_md1690}
This use case is implemented as the {\ttfamily \mbox{\hyperlink{group__keytest_gaf6e66e12fe04d535a5d1c8218ced803e}{key\+Cmp()}}} function.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1691}{}\doxysection{$<$tt$>$\+Key$<$/tt$>$ Hierarchy}\label{doc_contrib_usecases_api_core_md_autotoc_md1691}
This use case is currently implemented via the {\ttfamily \mbox{\hyperlink{group__keytest_ga03332b5d97c76a4fd2640aca4762b8df}{key\+Is\+Below()}}}, {\ttfamily \mbox{\hyperlink{keytest_8c_a6250a0bad75aa9abb20a98e69ad2d299}{key\+Is\+Below\+Or\+Same()}}} and {\ttfamily \mbox{\hyperlink{group__keytest_ga0150fb549225d8789e7297b919965e72}{key\+Is\+Directly\+Below()}}} functions, instead of being a single function.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1692}{}\doxysection{Create $<$tt$>$\+Key\+Set$<$/tt$>$}\label{doc_contrib_usecases_api_core_md_autotoc_md1692}
This use case is implemented as {\ttfamily \mbox{\hyperlink{group__keyset_ga671e1aaee3ae9dc13b4834a4ddbd2c3c}{ks\+New()}}}. Beyond the described use case, the {\ttfamily \mbox{\hyperlink{group__keyset_ga671e1aaee3ae9dc13b4834a4ddbd2c3c}{ks\+New()}}} function also supports creating a {\ttfamily Key\+Set} with predefined contents.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1693}{}\doxysection{Insert $<$tt$>$\+Key$<$/tt$>$ into $<$tt$>$\+Key\+Set$<$/tt$>$}\label{doc_contrib_usecases_api_core_md_autotoc_md1693}
This use case is implemented as {\ttfamily \mbox{\hyperlink{group__keyset_gaa5a1d467a4d71041edce68ea7748ce45}{ks\+Append\+Key()}}} and {\ttfamily \mbox{\hyperlink{group__keyset_ga21eb9c3a14a604ee3a8bdc779232e7b7}{ks\+Append()}}}.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1694}{}\doxysection{Remove $<$tt$>$\+Key$<$/tt$>$ from $<$tt$>$\+Key\+Set$<$/tt$>$}\label{doc_contrib_usecases_api_core_md_autotoc_md1694}
This use case is implemented via {\ttfamily \mbox{\hyperlink{group__keyset_ga60f1ddcf23272f2b29b90e92ebe9b56f}{ks\+Lookup()}}} with the {\ttfamily KDB\+\_\+\+O\+\_\+\+POP} option.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1695}{}\doxysection{Direct lookup in $<$tt$>$\+Key\+Set$<$/tt$>$}\label{doc_contrib_usecases_api_core_md_autotoc_md1695}
This use case is implemented via {\ttfamily \mbox{\hyperlink{group__keyset_ga60f1ddcf23272f2b29b90e92ebe9b56f}{ks\+Lookup()}}}.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1696}{}\doxysection{Cascading Lookup in $<$tt$>$\+Key\+Set$<$/tt$>$}\label{doc_contrib_usecases_api_core_md_autotoc_md1696}
This use case is implemented via {\ttfamily \mbox{\hyperlink{group__keyset_ga60f1ddcf23272f2b29b90e92ebe9b56f}{ks\+Lookup()}}}.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1697}{}\doxysection{Index access to $<$tt$>$\+Key\+Set$<$/tt$>$}\label{doc_contrib_usecases_api_core_md_autotoc_md1697}
This use case is implemented as {\ttfamily \mbox{\hyperlink{group__keyset_gab3fb5e067c672d9fd60a4022b2ae9dd1}{ks\+At\+Cursor()}}}.\hypertarget{doc_contrib_usecases_api_core_md_autotoc_md1698}{}\doxysection{Cut $<$tt$>$\+Key$<$/tt$>$ hierarchy from $<$tt$>$\+Key\+Set$<$/tt$>$}\label{doc_contrib_usecases_api_core_md_autotoc_md1698}
This use case is implemented as {\ttfamily \mbox{\hyperlink{group__keyset_ga6b00cf82b59af4d883a9bad6cf4a4a4a}{ks\+Cut()}}}. 