bug #504 fix

[idzebra-moved-to-github.git] / include / idzebra / util.h

diff --git a/include/idzebra/util.h b/include/idzebra/util.h
index 41f356e..0744fea 100644 (file)
--- a/include/idzebra/util.h
+++ b/include/idzebra/util.h
@@ -1,4 +1,4 @@
-/* $Id: util.h,v 1.1 2005-03-30 09:25:23 adam Exp $
+/* $Id: util.h,v 1.7 2006-05-19 13:49:34 adam Exp $
    Copyright (C) 1995-2005
    Index Data ApS
 
@@ -23,7 +23,8 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #ifndef ZEBRA_UTIL_H
 #define ZEBRA_UTIL_H
 
-#include <yaz/yaz-util.h>
+#include <yaz/yconfig.h>
+#include <yaz/log.h>
 
 #include <idzebra/version.h>
 
@@ -34,6 +35,13 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 
 YAZ_BEGIN_CDECL
 
+/** \var zint
+ * \brief Zebra integer
+ *
+ * This integer is used in various Zebra APIs to specify record identifires,
+ * number of occurrences etc. It is a "large" integer and is usually
+ * 64-bit on newer architectures.
+ */
 #ifdef __GNUC__
 typedef long long int zint;
 #define ZINT_FORMAT "%lld"
@@ -50,6 +58,16 @@ typedef long zint;
 #endif
 #endif
 
+/** \var typedef ZEBRA_RES
+ * \brief Common return type for Zebra API
+ *
+ * This return code indicates success with code ZEBRA_OK and failure
+ * with ZEBRA_FAIL
+ */
+typedef short ZEBRA_RES;
+#define ZEBRA_FAIL -1
+#define ZEBRA_OK   0
+
 typedef zint SYSNO;
 
 YAZ_EXPORT
@@ -67,3 +85,11 @@ YAZ_END_CDECL
 #define CAST_ZINT_TO_DOUBLE(x) (double)(x)
 
 #endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+