[#CDBIterator-GetKey]
= xref:CDBIterator.adoc[CDBIterator]::GetKey
:relfileprefix: ../
:mrdocs:

Reads the key at the current position.

== Synopsis

Declared in `<dbwrapper.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<typename K>
bool
GetKey(K& key);
----

== Return Value

True if the key was read successfully, false otherwise.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *key*
| Set to the deserialized key on success.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#