Updated footer comment
[idzebra-moved-to-github.git] / index / reckeys.h
1 /* This file is part of the Zebra server.
2    Copyright (C) 1994-2009 Index Data
3
4 Zebra is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
7 version.
8
9 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
18 */
19
20 #ifndef RECKEYS_H
21 #define RECKEYS_H
22
23 #include <yaz/yconfig.h>
24 #include "it_key.h"
25
26 YAZ_BEGIN_CDECL
27
28 typedef struct zebra_rec_keys_t_ *zebra_rec_keys_t;
29
30 zebra_rec_keys_t zebra_rec_keys_open(void);
31
32 void zebra_rec_keys_close(zebra_rec_keys_t p);
33
34 void zebra_rec_keys_write(zebra_rec_keys_t keys, 
35                           const char *str, size_t slen,
36                           const struct it_key *key);
37 void zebra_rec_keys_reset(zebra_rec_keys_t keys);
38
39 int zebra_rec_keys_read(zebra_rec_keys_t keys,
40                         const char **str, size_t *slen,
41                         struct it_key *key);
42 int zebra_rec_keys_rewind(zebra_rec_keys_t keys);
43
44 int zebra_rec_keys_empty(zebra_rec_keys_t keys);
45
46 void zebra_rec_keys_get_buf(zebra_rec_keys_t p, char **buf, size_t *sz);
47
48 void zebra_rec_keys_set_buf(zebra_rec_keys_t p, char *buf, size_t sz,
49                             int copy_buf);
50
51 zint zebra_rec_keys_get_custom_record_id(zebra_rec_keys_t keys);
52 YAZ_END_CDECL
53
54 #endif
55 /*
56  * Local variables:
57  * c-basic-offset: 4
58  * c-file-style: "Stroustrup"
59  * indent-tabs-mode: nil
60  * End:
61  * vim: shiftwidth=4 tabstop=8 expandtab
62  */
63