dbh_macros man page

-

dbh_macros — Macros available in dbh

Synopsis

#include <dbh.h>

unsigned char DBH_KEYLENGTH (DBHashTable * dbh);
FILE_POINTER DBH_RECORD_SIZE (DBHashTable * dbh);
void *DBH_KEY (DBHashTable * dbh);
void *DBH_DATA (DBHashTable * dbh);
FILE_POINTER DBH_ERASED_SPACE (DBHashTable * dbh);
FILE_POINTER DBH_DATA_SPACE (DBHashTable * dbh);
FILE_POINTER DBH_TOTAL_SPACE (DBHashTable * dbh);
FILE_POINTER DBH_FORMAT_SPACE (DBHashTable * dbh);
FILE_POINTER DBH_RECORDS (DBHashTable * dbh);
FILE_POINTER DBH_MAXIMUM_RECORD_SIZE (DBHashTable * dbh);
char *DBH_PATH (DBHashTable * dbh);

Description

Convenience macros to retrieve DBHashTable structure elements.

Dbh_keylength ()

This macro returns the keylenth in bytes associated to the DBHashTable. The value is fixed when the DBHashTable is created with dbh_create.

Dbh_record_size ()

This macro returns the size of the current record loaded in memory. If no record has been loaded, then the return value is not defined.

Dbh_key ()

This macro returns a pointer to the current DBHashTable key area.

Dbh_data ()

This macro returns a pointer to the current DBHashTable data area.

Dbh_erased_space ()

This macro returns the amount of bytes taken up by erased data in the DBHashTable.

Dbh_data_space ()

This macro returns the amount of bytes taken up by valid data in the DBHashTable.

Dbh_total_space ()

This macro returns the total amount of bytes taken up by the DBHashTable.

Dbh_format_space ()

This macro returns the total amount of bytes taken up by the format of the DBHashTable.

Dbh_records ()

This macro returns the number of records in the DBHashTable.

Dbh_maximum_record_size ()

This macro returns the maximum allocated space for data in the current DBHashTable record.

Dbh_path ()

This macro returns a pointer to a string containing the path to the current DBHashTable.

See Also

dbh (0)

Author

Edscott Wilson Garcia <edscott@xfce.org>

Info

DBH DBHashTables DBHashTables Programmers' Manual