libs/dbprim/he_init.c

   1 /*
   2 ** Copyright (C) 2002 by Kevin L. Mitchell <klmitch@mit.edu>
   3 **
   4 ** This library is free software; you can redistribute it and/or
   5 ** modify it under the terms of the GNU Library General Public
   6 ** License as published by the Free Software Foundation; either
   7 ** version 2 of the License, or (at your option) any later version.
   8 **
   9 ** This library is distributed in the hope that it will be useful,
  10 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 ** Library General Public License for more details.
  13 **
  14 ** You should have received a copy of the GNU Library General Public
  15 ** License along with this library; if not, write to the Free
  16 ** Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  17 ** MA 02111-1307, USA
  18 **
  19 ** @(#)$Id$
  20 */
  21 #include "dbprim.h"
  22 #include "dbprim_int.h"
  23
  24 RCSTAG("@(#)$Id$");
  25
  26 /** \ingroup dbprim_hash
  27  * \brief Dynamically initialize a hash table entry.
  28  *
  29  * This function dynamically initializes a hash table entry.
  30  *
  31  * \param entry A pointer to a #hash_entry_t to be initialized.
  32  * \param value A pointer to \c void which will be the value of the
  33  *              hash table entry.
  34  *
  35  * \retval DB_ERR_BADARGS       A \c NULL pointer was passed for \p
  36  *                              entry.
  37  */
  38 unsigned long
  39 he_init(hash_entry_t *entry, void *value)
  40 {
  41   unsigned long retval;
  42
  43   initialize_dbpr_error_table(); /* initialize error table */
  44
  45   if (!entry) /* verify arguments */
  46     return DB_ERR_BADARGS;
  47
  48   /* initialize the link entry */
  49   if ((retval = le_init(&entry->he_elem, entry)))
  50     return retval;
  51
  52   entry->he_table = 0; /* initialize the rest of the hash entry */
  53   entry->he_hash = 0;
  54   entry->he_key.dk_key = 0;
  55   entry->he_key.dk_len = 0;
  56   entry->he_value = value;
  57
  58   entry->he_magic = HASH_ENTRY_MAGIC; /* set the magic number */
  59
  60   return 0;
  61 }