libs/dbprim/ll_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_link
  27  * \brief Dynamically initialize a linked list head.
  28  *
  29  * This function dynamically initializes a linked list head.
  30  *
  31  * \param list  A pointer to a #link_head_t to be initialized.
  32  * \param extra A pointer to \c void containing extra pointer data
  33  *              associated with the linked list.
  34  *
  35  * \retval DB_ERR_BADARGS       A \c NULL pointer was passed for \p
  36  *                              list.
  37  */
  38 unsigned long
  39 ll_init(link_head_t *list, void *extra)
  40 {
  41   initialize_dbpr_error_table(); /* set up error tables */
  42
  43   if (!list) /* must have a list head */
  44     return DB_ERR_BADARGS;
  45
  46   list->lh_count = 0; /* initialize the list head */
  47   list->lh_first = 0;
  48   list->lh_last = 0;
  49   list->lh_extra = extra;
  50
  51   list->lh_magic = LINK_HEAD_MAGIC; /* set the magic number */
  52
  53   return 0;
  54 }