X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fyaz%2Fzoom.h;h=50b448b61ca9d38b62424c1f356f22ee8228a34a;hb=2af1d65a7126d623ab596d831d6bc4257d75a051;hp=e321fd0230b15be739e6cd78914dffc5ca7d8a7d;hpb=eab4041057c94f4fd3feffd76c1f987ca67da1c3;p=yaz-moved-to-github.git diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h index e321fd0..50b448b 100644 --- a/include/yaz/zoom.h +++ b/include/yaz/zoom.h @@ -1,14 +1,19 @@ /* * Public header for ZOOM C. - * $Id: zoom.h,v 1.8 2001-12-30 22:21:11 adam Exp $ + * $Id: zoom.h,v 1.12 2002-05-17 12:48:29 adam Exp $ */ #include -#define ZOOM_EXPORT YAZ_EXPORT #define ZOOM_BEGIN_CDECL YAZ_BEGIN_CDECL #define ZOOM_END_CDECL YAZ_END_CDECL +#ifdef WIN32 +# define ZOOM_API(x) __declspec(dllexport) x __stdcall +#else +# define ZOOM_API(x) x +# endif + ZOOM_BEGIN_CDECL /* ----------------------------------------------------------- */ @@ -27,46 +32,46 @@ typedef struct ZOOM_scanset_p *ZOOM_scanset; /* create connection, connect to host, if portnum is 0, then port is read from host string (e.g. myhost:9821) */ -ZOOM_EXPORT -ZOOM_connection ZOOM_connection_new (const char *host, int portnum); +ZOOM_API(ZOOM_connection) +ZOOM_connection_new (const char *host, int portnum); /* create connection, don't connect, apply options */ -ZOOM_EXPORT -ZOOM_connection ZOOM_connection_create (ZOOM_options options); +ZOOM_API(ZOOM_connection) +ZOOM_connection_create (ZOOM_options options); /* connect given existing connection */ -ZOOM_EXPORT -void ZOOM_connection_connect(ZOOM_connection c, const char *host, +ZOOM_API(void) +ZOOM_connection_connect(ZOOM_connection c, const char *host, int portnum); /* destroy connection (close connection also) */ -ZOOM_EXPORT -void ZOOM_connection_destroy (ZOOM_connection c); +ZOOM_API(void) +ZOOM_connection_destroy (ZOOM_connection c); /* get/set option for connection */ -ZOOM_EXPORT -const char *ZOOM_connection_option_get (ZOOM_connection c, const char *key); +ZOOM_API(const char *) +ZOOM_connection_option_get (ZOOM_connection c, const char *key); -ZOOM_EXPORT -void ZOOM_connection_option_set (ZOOM_connection c, const char *key, - const char *val); +ZOOM_API(void) +ZOOM_connection_option_set (ZOOM_connection c, const char *key, + const char *val); /* return error code (0 == success, failure otherwise). cp holds error string on failure, addinfo holds addititional info (if any) */ -ZOOM_EXPORT -int ZOOM_connection_error (ZOOM_connection c, const char **cp, +ZOOM_API(int) +ZOOM_connection_error (ZOOM_connection c, const char **cp, const char **addinfo); /* returns error code */ -ZOOM_EXPORT -int ZOOM_connection_errcode (ZOOM_connection c); +ZOOM_API(int) +ZOOM_connection_errcode (ZOOM_connection c); /* returns error message */ -ZOOM_EXPORT -const char *ZOOM_connection_errmsg (ZOOM_connection c); +ZOOM_API(const char *) +ZOOM_connection_errmsg (ZOOM_connection c); /* returns additional info */ -ZOOM_EXPORT -const char *ZOOM_connection_addinfo (ZOOM_connection c); +ZOOM_API(const char *) +ZOOM_connection_addinfo (ZOOM_connection c); #define ZOOM_ERROR_NONE 0 #define ZOOM_ERROR_CONNECT 10000 @@ -78,8 +83,8 @@ const char *ZOOM_connection_addinfo (ZOOM_connection c); #define ZOOM_ERROR_INTERNAL 10006 #define ZOOM_ERROR_TIMEOUT 10007 -ZOOM_EXPORT -int ZOOM_connection_last_event(ZOOM_connection cs); +ZOOM_API(int) +ZOOM_connection_last_event(ZOOM_connection cs); #define ZOOM_EVENT_NONE 0 #define ZOOM_EVENT_CONNECT 1 @@ -94,114 +99,122 @@ int ZOOM_connection_last_event(ZOOM_connection cs); /* result sets */ /* create result set given a search */ -ZOOM_EXPORT -ZOOM_resultset ZOOM_connection_search(ZOOM_connection, ZOOM_query q); +ZOOM_API(ZOOM_resultset) +ZOOM_connection_search(ZOOM_connection, ZOOM_query q); /* create result set given PQF query */ -ZOOM_EXPORT -ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c, const char *q); +ZOOM_API(ZOOM_resultset) +ZOOM_connection_search_pqf(ZOOM_connection c, const char *q); /* destroy result set */ -ZOOM_EXPORT -void ZOOM_resultset_destroy(ZOOM_resultset r); +ZOOM_API(void) +ZOOM_resultset_destroy(ZOOM_resultset r); /* result set option */ -ZOOM_EXPORT -const char *ZOOM_resultset_option_get (ZOOM_resultset r, const char *key); -ZOOM_EXPORT -void ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val); +ZOOM_API(const char *) +ZOOM_resultset_option_get (ZOOM_resultset r, const char *key); +ZOOM_API(void) +ZOOM_resultset_option_set (ZOOM_resultset r, const char *key, const char *val); /* return size of result set (alias hit count AKA result count) */ -ZOOM_EXPORT -size_t ZOOM_resultset_size (ZOOM_resultset r); +ZOOM_API(size_t) +ZOOM_resultset_size (ZOOM_resultset r); /* retrieve records */ -ZOOM_EXPORT -void ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs, - size_t start, size_t count); +ZOOM_API(void) +ZOOM_resultset_records (ZOOM_resultset r, ZOOM_record *recs, + size_t start, size_t count); /* return record object at pos. Returns 0 if unavailable */ -ZOOM_EXPORT -ZOOM_record ZOOM_resultset_record (ZOOM_resultset s, size_t pos); +ZOOM_API(ZOOM_record) +ZOOM_resultset_record (ZOOM_resultset s, size_t pos); /* like ZOOM_resultset_record - but never blocks .. */ -ZOOM_EXPORT -ZOOM_record ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos); +ZOOM_API(ZOOM_record) +ZOOM_resultset_record_immediate (ZOOM_resultset s, size_t pos); /* ----------------------------------------------------------- */ /* records */ /* get record information, in a form given by type */ -ZOOM_EXPORT -void *ZOOM_record_get (ZOOM_record rec, const char *type, size_t *len); +ZOOM_API(const char *) +ZOOM_record_get (ZOOM_record rec, const char *type, int *len); /* destroy record */ -ZOOM_EXPORT -void ZOOM_record_destroy (ZOOM_record rec); +ZOOM_API(void) +ZOOM_record_destroy (ZOOM_record rec); /* return copy of record */ -ZOOM_EXPORT -ZOOM_record ZOOM_record_clone (ZOOM_record srec); +ZOOM_API(ZOOM_record) +ZOOM_record_clone (ZOOM_record srec); /* ----------------------------------------------------------- */ /* queries */ /* create search object */ -ZOOM_EXPORT -ZOOM_query ZOOM_query_create(void); +ZOOM_API(ZOOM_query) +ZOOM_query_create(void); /* destroy it */ -ZOOM_EXPORT -void ZOOM_query_destroy(ZOOM_query s); +ZOOM_API(void) +ZOOM_query_destroy(ZOOM_query s); /* specify prefix query for search */ -ZOOM_EXPORT -int ZOOM_query_prefix(ZOOM_query s, const char *str); +ZOOM_API(int) +ZOOM_query_prefix(ZOOM_query s, const char *str); /* specify sort criteria for search */ -ZOOM_EXPORT -int ZOOM_query_sortby(ZOOM_query s, const char *criteria); +ZOOM_API(int) +ZOOM_query_sortby(ZOOM_query s, const char *criteria); /* ----------------------------------------------------------- */ /* scan */ -ZOOM_EXPORT -ZOOM_scanset ZOOM_connection_scan (ZOOM_connection c, const char *startterm); +ZOOM_API(ZOOM_scanset) +ZOOM_connection_scan (ZOOM_connection c, const char *startterm); + +ZOOM_API(const char *) +ZOOM_scanset_term(ZOOM_scanset scan, size_t pos, + int *occ, int *len); + +ZOOM_API(size_t) +ZOOM_scanset_size(ZOOM_scanset scan); -ZOOM_EXPORT -const char * ZOOM_scanset_term(ZOOM_scanset scan, size_t no, int *occ, size_t *len); +ZOOM_API(void) +ZOOM_scanset_destroy (ZOOM_scanset scan); -ZOOM_EXPORT -size_t ZOOM_scanset_size(ZOOM_scanset scan); +ZOOM_API(const char *) +ZOOM_scanset_option_get (ZOOM_scanset scan, const char *key); -ZOOM_EXPORT -void ZOOM_scanset_destroy (ZOOM_scanset scan); +ZOOM_API(void) +ZOOM_scanset_option_set (ZOOM_scanset scan, const char *key, + const char *val); /* ----------------------------------------------------------- */ /* options */ typedef const char *(*ZOOM_options_callback)(void *handle, const char *name); -ZOOM_EXPORT -ZOOM_options_callback ZOOM_options_set_callback (ZOOM_options opt, +ZOOM_API(ZOOM_options_callback) +ZOOM_options_set_callback (ZOOM_options opt, ZOOM_options_callback c, void *handle); -ZOOM_EXPORT -ZOOM_options ZOOM_options_create (void); +ZOOM_API(ZOOM_options) +ZOOM_options_create (void); -ZOOM_EXPORT -ZOOM_options ZOOM_options_create_with_parent (ZOOM_options parent); +ZOOM_API(ZOOM_options) +ZOOM_options_create_with_parent (ZOOM_options parent); -ZOOM_EXPORT -const char *ZOOM_options_get (ZOOM_options opt, const char *name); +ZOOM_API(const char *) +ZOOM_options_get (ZOOM_options opt, const char *name); -ZOOM_EXPORT -void ZOOM_options_set (ZOOM_options opt, const char *name, const char *v); +ZOOM_API(void) +ZOOM_options_set (ZOOM_options opt, const char *name, const char *v); -ZOOM_EXPORT -void ZOOM_options_destroy (ZOOM_options opt); +ZOOM_API(void) +ZOOM_options_destroy (ZOOM_options opt); -ZOOM_EXPORT -int ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa); +ZOOM_API(int) +ZOOM_options_get_bool (ZOOM_options opt, const char *name, int defa); -ZOOM_EXPORT -int ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa); +ZOOM_API(int) +ZOOM_options_get_int (ZOOM_options opt, const char *name, int defa); -ZOOM_EXPORT -void ZOOM_options_addref (ZOOM_options opt); +ZOOM_API(void) +ZOOM_options_set_int(ZOOM_options opt, const char *name, int value); /* ----------------------------------------------------------- */ /* events */ @@ -209,7 +222,7 @@ void ZOOM_options_addref (ZOOM_options opt); integer if event occurred ; zero if none occurred and no more events are pending. The positive integer specifies the connection for which the event occurred. */ -ZOOM_EXPORT -int ZOOM_event (int no, ZOOM_connection *cs); +ZOOM_API(int) +ZOOM_event (int no, ZOOM_connection *cs); ZOOM_END_CDECL