\hypertarget{struct__Key}{
\section{\_\-Key Struct Reference}
\label{struct__Key}\index{\_\-Key@{\_\-Key}}
}


{\ttfamily \#include $<$kdbprivate.h$>$}



Collaboration diagram for \_\-Key:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=137pt]{struct__Key__coll__graph}
\end{center}
\end{figure}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\begin{tabbing}
xx\=xx\=xx\=xx\=xx\=xx\=xx\=xx\=xx\=\kill
union \{\\
\} \hyperlink{struct__Key_adc2c86e77553ed8224c9516487299459}{data}\\

\end{tabbing}\item 
size\_\-t \hyperlink{struct__Key_a4fd6239c6f82dd78181d6b497ff30f7e}{dataSize}
\item 
char $\ast$ \hyperlink{struct__Key_a652aa968b98b0797d4d080b51133fed9}{key}
\item 
size\_\-t \hyperlink{struct__Key_ab05bb76f9e389692dcea59f581e76323}{keySize}
\item 
keyflag\_\-t \hyperlink{struct__Key_a84a30dda173b302305eca6af5f766bc7}{flags}
\item 
size\_\-t \hyperlink{struct__Key_ab8fe2e580d4ab3952a071c25550598ef}{ksReference}
\item 
\hyperlink{struct__KeySet}{KeySet} $\ast$ \hyperlink{struct__Key_ad1596880712126bad997404b176872f5}{meta}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
The private Key struct.

Its internal private attributes should not be accessed directly by regular programs. Use the \hyperlink{group__key}{Key access methods} instead. Only a backend writer needs to have access to the private attributes of the Key object which is defined as: 
\begin{DoxyCode}
typedef struct _Key Key;
\end{DoxyCode}
 

\subsection{Field Documentation}
\hypertarget{struct__Key_adc2c86e77553ed8224c9516487299459}{
\index{\_\-Key@{\_\-Key}!data@{data}}
\index{data@{data}!_Key@{\_\-Key}}
\subsubsection[{data}]{\setlength{\rightskip}{0pt plus 5cm}union \{ ... \}   {\bf \_\-Key::data}}}
\label{struct__Key_adc2c86e77553ed8224c9516487299459}
The value, which is a NULL terminated string or binary. \begin{DoxySeeAlso}{See also}
keyString(), keyBinary(), 

\hyperlink{group__keyvalue_ga41b9fac5ccddafe407fc0ae1e2eb8778}{keyGetString()}, \hyperlink{group__keyvalue_ga4c0d8a4a11174197699c231e0b5c3c84}{keyGetBinary()}, 

\hyperlink{group__keyvalue_ga622bde1eb0e0c4994728331326340ef2}{keySetString()}, \hyperlink{group__keyvalue_gaa50a5358fd328d373a45f395fa1b99e7}{keySetBinary()} 
\end{DoxySeeAlso}
\hypertarget{struct__Key_a4fd6239c6f82dd78181d6b497ff30f7e}{
\index{\_\-Key@{\_\-Key}!dataSize@{dataSize}}
\index{dataSize@{dataSize}!_Key@{\_\-Key}}
\subsubsection[{dataSize}]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t {\bf \_\-Key::dataSize}}}
\label{struct__Key_a4fd6239c6f82dd78181d6b497ff30f7e}
Size of the value, in bytes, including ending NULL. \begin{DoxySeeAlso}{See also}
\hyperlink{group__keyvalue_ga0dd737fadc16d4cf16720d17f066a9d3}{keyGetCommentSize()}, \hyperlink{group__keyvalue_ga8863a877a84fa46e6017fe72e49b89c1}{keySetComment()}, \hyperlink{group__keyvalue_gafb89735689929ff717cc9f2d0d0b46a2}{keyGetComment()} 
\end{DoxySeeAlso}
\hypertarget{struct__Key_a84a30dda173b302305eca6af5f766bc7}{
\index{\_\-Key@{\_\-Key}!flags@{flags}}
\index{flags@{flags}!_Key@{\_\-Key}}
\subsubsection[{flags}]{\setlength{\rightskip}{0pt plus 5cm}keyflag\_\-t {\bf \_\-Key::flags}}}
\label{struct__Key_a84a30dda173b302305eca6af5f766bc7}
Some control and internal flags. \hypertarget{struct__Key_a652aa968b98b0797d4d080b51133fed9}{
\index{\_\-Key@{\_\-Key}!key@{key}}
\index{key@{key}!_Key@{\_\-Key}}
\subsubsection[{key}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ {\bf \_\-Key::key}}}
\label{struct__Key_a652aa968b98b0797d4d080b51133fed9}
The name of the key. \begin{DoxySeeAlso}{See also}
\hyperlink{group__keyname_ga7699091610e7f3f43d2949514a4b35d9}{keySetName()}, \hyperlink{group__keyname_ga7699091610e7f3f43d2949514a4b35d9}{keySetName()} 
\end{DoxySeeAlso}
\hypertarget{struct__Key_ab05bb76f9e389692dcea59f581e76323}{
\index{\_\-Key@{\_\-Key}!keySize@{keySize}}
\index{keySize@{keySize}!_Key@{\_\-Key}}
\subsubsection[{keySize}]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t {\bf \_\-Key::keySize}}}
\label{struct__Key_ab05bb76f9e389692dcea59f581e76323}
Size of the name, in bytes, including ending NULL. \begin{DoxySeeAlso}{See also}
\hyperlink{group__keyname_gab29a850168d9b31c9529e90cf9ab68be}{keyGetName()}, \hyperlink{group__keyname_gabdbcfa51ed8a387e47ead207affa2d2e}{keyGetNameSize()}, \hyperlink{group__keyname_ga7699091610e7f3f43d2949514a4b35d9}{keySetName()} 
\end{DoxySeeAlso}
\hypertarget{struct__Key_ab8fe2e580d4ab3952a071c25550598ef}{
\index{\_\-Key@{\_\-Key}!ksReference@{ksReference}}
\index{ksReference@{ksReference}!_Key@{\_\-Key}}
\subsubsection[{ksReference}]{\setlength{\rightskip}{0pt plus 5cm}size\_\-t {\bf \_\-Key::ksReference}}}
\label{struct__Key_ab8fe2e580d4ab3952a071c25550598ef}
In how many keysets the key resists. \hyperlink{group__keyname_ga7699091610e7f3f43d2949514a4b35d9}{keySetName()} is only allowed if ksReference is 0. \begin{DoxySeeAlso}{See also}
\hyperlink{group__keyset_gae42530b04defb772059de0600159cf69}{ksPop()}, \hyperlink{group__keyset_gaa5a1d467a4d71041edce68ea7748ce45}{ksAppendKey()}, \hyperlink{group__keyset_ga21eb9c3a14a604ee3a8bdc779232e7b7}{ksAppend()} 
\end{DoxySeeAlso}
\hypertarget{struct__Key_ad1596880712126bad997404b176872f5}{
\index{\_\-Key@{\_\-Key}!meta@{meta}}
\index{meta@{meta}!_Key@{\_\-Key}}
\subsubsection[{meta}]{\setlength{\rightskip}{0pt plus 5cm}{\bf KeySet}$\ast$ {\bf \_\-Key::meta}}}
\label{struct__Key_ad1596880712126bad997404b176872f5}
All the key's meta information. 

The documentation for this struct was generated from the following file:\begin{DoxyCompactItemize}
\item 
kdbprivate.h\end{DoxyCompactItemize}
