ham_record_t Struct Reference

#include <hamsterdb.h>

Data Fields
ham_size_t	size
void *	data
ham_u32_t	flags
ham_u32_t	_intflags
ham_u64_t	_rid

---

Detailed Description

A generic record.

A record represents data items in hamsterdb. Before using a record, it is important to initialize all record fields with zeroes, i.e. with the C library routines memset(3) or bzero(2).

When hamsterdb returns a record structure, the pointer to the record data is provided in data. This pointer is only temporary and will be overwritten by subsequent hamsterdb API calls.

To avoid this, the calling application can allocate the data pointer. In this case, you have to set the flag HAM_RECORD_USER_ALLOC. The size parameter will then return the size of the record. It's the responsibility of the caller to make sure that the data parameter is large enough for the record.

Definition at line 74 of file hamsterdb.h.

---

Field Documentation

ham_size_t ham_record_t::size

The size of the record data, in bytes

Definition at line 77 of file hamsterdb.h.

Referenced by ham::record::get_size(), ham::record::record(), and ham::record::set_size().

---

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

• include/ham/hamsterdb.h