X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;ds=sidebyside;f=include%2Fyaz%2Fzoom.h;h=ecdeabd138dccf65a94f89d757d253e071c6239f;hb=3a12e23d93ba2aadcddefc74ebe02b90f53381c3;hp=c5bca0e153b0f85613b018f30707e0e9a842ab5f;hpb=d9d97a04b6f9597225b8440dad61790dfa39a751;p=yaz-moved-to-github.git diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h index c5bca0e..ecdeabd 100644 --- a/include/yaz/zoom.h +++ b/include/yaz/zoom.h @@ -1,8 +1,15 @@ /* - * Public header for ZOOM C. - * $Id: zoom.h,v 1.17 2003-02-17 14:35:42 adam Exp $ + * Copyright (C) 1995-2005, Index Data ApS + * See the file LICENSE for details. + * + * $Id: zoom.h,v 1.28 2005-10-17 12:25:04 mike Exp $ + */ +/** + * \file zoom.h + * \brief Header for ZOOM */ +#include #include #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL @@ -22,8 +29,7 @@ ZOOM_BEGIN_CDECL typedef struct ZOOM_options_p *ZOOM_options; typedef struct ZOOM_query_p *ZOOM_query; typedef struct ZOOM_connection_p *ZOOM_connection; -typedef struct ZOOM_resultset_p *ZOOM_resultset; -typedef struct ZOOM_task_p *ZOOM_task; +typedef struct ZOOM_resultset_p *ZOOM_resultset; typedef struct ZOOM_record_p *ZOOM_record; typedef struct ZOOM_scanset_p *ZOOM_scanset; typedef struct ZOOM_package_p *ZOOM_package; @@ -45,7 +51,7 @@ ZOOM_connection_create (ZOOM_options options); /* connect given existing connection */ ZOOM_API(void) ZOOM_connection_connect(ZOOM_connection c, const char *host, - int portnum); + int portnum); /* destroy connection (close connection also) */ ZOOM_API(void) @@ -55,16 +61,23 @@ ZOOM_connection_destroy (ZOOM_connection c); ZOOM_API(const char *) ZOOM_connection_option_get (ZOOM_connection c, const char *key); +ZOOM_API(const char *) +ZOOM_connection_option_getl (ZOOM_connection c, const char *key, int *lenp); + ZOOM_API(void) ZOOM_connection_option_set (ZOOM_connection c, const char *key, const char *val); +ZOOM_API(void) +ZOOM_connection_option_setl (ZOOM_connection c, const char *key, + const char *val, int len); + /* return error code (0 == success, failure otherwise). cp holds error string on failure, addinfo holds addititional info (if any) */ ZOOM_API(int) ZOOM_connection_error (ZOOM_connection c, const char **cp, - const char **addinfo); + const char **addinfo); ZOOM_API(int) ZOOM_connection_error_x (ZOOM_connection c, const char **cp, @@ -94,6 +107,7 @@ ZOOM_diag_str (int error); #define ZOOM_ERROR_TIMEOUT 10007 #define ZOOM_ERROR_UNSUPPORTED_PROTOCOL 10008 #define ZOOM_ERROR_UNSUPPORTED_QUERY 10009 +#define ZOOM_ERROR_INVALID_QUERY 10010 ZOOM_API(int) ZOOM_connection_last_event(ZOOM_connection cs); @@ -106,6 +120,8 @@ ZOOM_connection_last_event(ZOOM_connection cs); #define ZOOM_EVENT_UNKNOWN 5 #define ZOOM_EVENT_SEND_APDU 6 #define ZOOM_EVENT_RECV_APDU 7 +#define ZOOM_EVENT_RECV_RECORD 8 +#define ZOOM_EVENT_RECV_SEARCH 9 /* ----------------------------------------------------------- */ /* result sets */ @@ -144,6 +160,10 @@ ZOOM_resultset_record (ZOOM_resultset s, size_t pos); ZOOM_API(ZOOM_record) ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos); +/* reset record cache for result set */ +ZOOM_API(void) +ZOOM_resultset_cache_reset(ZOOM_resultset r); + /* ----------------------------------------------------------- */ /* records */ @@ -187,6 +207,10 @@ ZOOM_API(const char *) ZOOM_scanset_term(ZOOM_scanset scan, size_t pos, int *occ, int *len); +ZOOM_API(const char *) +ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos, + int *occ, int *len); + ZOOM_API(size_t) ZOOM_scanset_size(ZOOM_scanset scan); @@ -219,6 +243,12 @@ ZOOM_API(void) const char *val); /* ----------------------------------------------------------- */ +/* Sort */ +ZOOM_API(void) + ZOOM_resultset_sort(ZOOM_resultset r, + const char *sort_type, const char *sort_spec); + +/* ----------------------------------------------------------- */ /* options */ ZOOM_API(ZOOM_options_callback) @@ -238,6 +268,9 @@ ZOOM_API(ZOOM_options) ZOOM_API(const char *) ZOOM_options_get (ZOOM_options opt, const char *name); +ZOOM_API(const char *) +ZOOM_options_getl (ZOOM_options opt, const char *name, int *lenp); + ZOOM_API(void) ZOOM_options_set (ZOOM_options opt, const char *name, const char *v); @@ -267,3 +300,11 @@ ZOOM_API(int) ZOOM_event (int no, ZOOM_connection *cs); ZOOM_END_CDECL +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +