src/gtx/gtxobjdict.h

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10 #ifndef __gator_objdict_h
  11 #define __gator_objdict_h  1
  12
  13 /*--------------------------------------------------------------------------------
  14  * objdict.h
  15  *
  16  * Definitions for the gator object dictionary.
  17  *--------------------------------------------------------------------------------*/
  18
  19 #include "gtxobjects.h"         /*Standard gator object defns */
  20
  21 extern int gator_objdict_init(int adebug);
  22     /*
  23      * Summary:
  24      *    Initialize the gator object dictionary package.
  25      *
  26      * Args:
  27      *    int adebug: Is debugging output turned on?
  28      *
  29      * Returns:
  30      *    0 on success,
  31      *    Error value otherwise.
  32      */
  33
  34 extern int gator_objdict_add(struct onode *objtoadd);
  35     /*
  36      * Summary:
  37      *    Add an entry to the gator object dictionary.
  38      *
  39      * Args:
  40      *    struct onode *objtoadd: Ptr to object to add.
  41      *
  42      * Returns:
  43      *    0 on success,
  44      *    Error value otherwise.
  45      */
  46
  47 extern int gator_objdict_delete(struct onode *objtodelete);
  48     /*
  49      * Summary:
  50      *    Delete an entry from the gator object dictionary.
  51      *
  52      * Args:
  53      *    struct onode *objtodelete: Ptr to object to delete.
  54      *
  55      * Returns:
  56      *    0 on success,
  57      *    Error value otherwise.
  58      */
  59
  60 extern struct onode *gator_objdict_lookup(char *nametofind);
  61     /*
  62      * Summary:
  63      *    Look up a gator object by name.
  64      *
  65      * Args:
  66      *    char *nametofind: String name of desired onode.
  67      *
  68      * Returns:
  69      *    Ptr to desired onode if successful,
  70      *    Null pointer otherwise.
  71      */
  72
  73 #endif /* __gator_objdict_h */