_Key Struct Reference

#include <kdbprivate.h>

Data Fields
union {
}	data
size_t	dataSize
char *	key
size_t	keySize
keyflag_t	flags
size_t	ksReference
KeySet *	meta

---

Detailed Description

The private Key struct.

Its internal private attributes should not be accessed directly by regular programs. Use the Key access methods instead. Only a backend writer needs to have access to the private attributes of the Key object which is defined as:

typedef struct _Key Key;

---

Field Documentation

union { ... } _Key::data

The value, which is a NULL terminated string or binary.

See also:

keyString(), keyBinary(),

keyGetString(), keyGetBinary(),

keySetString(), keySetBinary()

size_t _Key::dataSize

Size of the value, in bytes, including ending NULL.

See also:

keyGetCommentSize(), keySetComment(), keyGetComment()

keyflag_t _Key::flags

Some control and internal flags.

char* _Key::key

The name of the key.

See also:

keySetName(), keySetName()

size_t _Key::keySize

Size of the name, in bytes, including ending NULL.

See also:

keyGetName(), keyGetNameSize(), keySetName()

size_t _Key::ksReference

In how many keysets the key resists. keySetName() is only allowed if ksReference is 0.

See also:

ksPop(), ksAppendKey(), ksAppend()

KeySet* _Key::meta

All the key's meta information.

---

The documentation for this struct was generated from the following file:

• kdbprivate.h