3b33b723384e4e68bf0b9bb9ae8315e5397d1c54
[idzebra-moved-to-github.git] / index / reckeys.h
1 /* $Id: reckeys.h,v 1.10 2007-11-30 12:19:08 adam Exp $
2    Copyright (C) 1995-2007
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 this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20
21 */
22
23 #ifndef RECKEYS_H
24 #define RECKEYS_H
25
26 #include <yaz/yconfig.h>
27 #include "it_key.h"
28
29 YAZ_BEGIN_CDECL
30
31 typedef struct zebra_rec_keys_t_ *zebra_rec_keys_t;
32
33 zebra_rec_keys_t zebra_rec_keys_open(void);
34
35 void zebra_rec_keys_close(zebra_rec_keys_t p);
36
37 void zebra_rec_keys_write(zebra_rec_keys_t keys, 
38                           const char *str, size_t slen,
39                           const struct it_key *key);
40 void zebra_rec_keys_reset(zebra_rec_keys_t keys);
41
42 int zebra_rec_keys_read(zebra_rec_keys_t keys,
43                         const char **str, size_t *slen,
44                         struct it_key *key);
45 int zebra_rec_keys_rewind(zebra_rec_keys_t keys);
46
47 int zebra_rec_keys_empty(zebra_rec_keys_t keys);
48
49 void zebra_rec_keys_get_buf(zebra_rec_keys_t p, char **buf, size_t *sz);
50
51 void zebra_rec_keys_set_buf(zebra_rec_keys_t p, char *buf, size_t sz,
52                             int copy_buf);
53
54 zint zebra_rec_keys_get_custom_record_id(zebra_rec_keys_t keys);
55 YAZ_END_CDECL
56
57 #endif
58 /*
59  * Local variables:
60  * c-basic-offset: 4
61  * indent-tabs-mode: nil
62  * End:
63  * vim: shiftwidth=4 tabstop=8 expandtab
64  */
65