1dbh_macros(3)          DBHashTables Programmers' Manual          dbh_macros(3)
2
3
4
5‐
6

NAME

8       dbh_macros - Macros available in dbh
9

SYNOPSIS

11       #include <dbh.h>
12
13       unsigned char DBH_KEYLENGTH (DBHashTable * dbh);
14       FILE_POINTER DBH_RECORD_SIZE (DBHashTable * dbh);
15       void *DBH_KEY (DBHashTable * dbh);
16       void *DBH_DATA (DBHashTable * dbh);
17       FILE_POINTER DBH_ERASED_SPACE (DBHashTable * dbh);
18       FILE_POINTER DBH_DATA_SPACE (DBHashTable * dbh);
19       FILE_POINTER DBH_TOTAL_SPACE (DBHashTable * dbh);
20       FILE_POINTER DBH_FORMAT_SPACE (DBHashTable * dbh);
21       FILE_POINTER DBH_RECORDS (DBHashTable * dbh);
22       FILE_POINTER DBH_MAXIMUM_RECORD_SIZE (DBHashTable * dbh);
23       char *DBH_PATH (DBHashTable * dbh);
24

DESCRIPTION

26       Convenience macros to retrieve DBHashTable structure elements.
27
28   DBH_KEYLENGTH ()
29       This macro returns the keylenth in bytes associated to the DBHashTable.
30       The value is fixed when the DBHashTable is created with dbh_create.
31
32   DBH_RECORD_SIZE ()
33       This macro returns the size of the current record loaded in memory.  If
34       no record has been loaded, then the return value is not defined.
35
36   DBH_KEY ()
37       This macro returns a pointer to the current DBHashTable key area.
38
39   DBH_DATA ()
40       This macro returns a pointer to the current DBHashTable data area.
41
42   DBH_ERASED_SPACE ()
43       This  macro  returns the amount of bytes taken up by erased data in the
44       DBHashTable.
45
46   DBH_DATA_SPACE ()
47       This macro returns the amount of bytes taken up by valid  data  in  the
48       DBHashTable.
49
50   DBH_TOTAL_SPACE ()
51       This  macro  returns  the  total  amount  of  bytes  taken  up  by  the
52       DBHashTable.
53
54   DBH_FORMAT_SPACE ()
55       This macro returns the total amount of bytes taken up by the format  of
56       the DBHashTable.
57
58   DBH_RECORDS ()
59       This macro returns the number of records in the DBHashTable.
60
61   DBH_MAXIMUM_RECORD_SIZE ()
62       This  macro returns the maximum allocated space for data in the current
63       DBHashTable record.
64
65   DBH_PATH ()
66       This macro returns a pointer to a string containing  the  path  to  the
67       current DBHashTable.
68

SEE ALSO

70       dbh (0)
71

Author

73       Edscott Wilson Garcia <edscott@xfce.org>
74
75
76
77
78DBHashTables                          DBH                        dbh_macros(3)