Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
-
dbh_macros(3)		DBHashTables Programmers' Manual	   dbh_macros(3)

NAME
     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  DB-
     HashTable.

   DBH_DATA_SPACE ()
     This  macro  returns  the amount of bytes taken up by valid data in the DB-
     HashTable.

   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 DB-
     HashTable 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>

DBHashTables			       DBH			   dbh_macros(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=dbh_macros&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help