Added a utility res_clear which removes/clears all items in a
[idzebra-moved-to-github.git] / include / idzebra / res.h
1 /* $Id: res.h,v 1.6 2005-08-17 21:28:07 adam Exp $
2    Copyright (C) 1995-2005
3    Index Data ApS
4
5 This file is part of the Zebra server.
6
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
10 version.
11
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
20 02111-1307, USA.
21 */
22
23 #ifndef IDZEBRA_RES_H
24 #define IDZEBRA_RES_H
25
26 #include <idzebra/util.h>
27
28 YAZ_BEGIN_CDECL
29
30 typedef struct res_struct *Res;
31
32 YAZ_EXPORT
33 Res res_open (const char *name, Res res_def, Res over_res);
34
35 YAZ_EXPORT
36 void res_close (Res r);
37
38 YAZ_EXPORT
39 void res_clear (Res r);
40
41 YAZ_EXPORT
42 const char *res_get (Res r, const char *name);
43
44 YAZ_EXPORT
45 const char *res_get_def (Res r, const char *name, const char *def);
46
47 YAZ_EXPORT
48 int res_get_match (Res r, const char *name, const char *value, const char *s);
49
50 YAZ_EXPORT
51 void res_set (Res r, const char *name, const char *value);
52
53 YAZ_EXPORT
54 int res_trav (Res r, const char *prefix, void *p,
55               void (*f)(void *p, const char *name, const char *value));
56
57 YAZ_EXPORT
58 int res_write (Res r);
59
60 YAZ_EXPORT
61 const char *res_get_prefix (Res r, const char *name, const char *prefix,
62                             const char *def);
63
64 YAZ_EXPORT
65 ZEBRA_RES res_get_int(Res r, const char *name, int *val);
66
67 YAZ_END_CDECL
68
69 #endif