Added a utility res_clear which removes/clears all items in a
[idzebra-moved-to-github.git] / include / idzebra / util.h
index 41f356e..6d2a74d 100644 (file)
@@ -1,4 +1,4 @@
-/* $Id: util.h,v 1.1 2005-03-30 09:25:23 adam Exp $
+/* $Id: util.h,v 1.4 2005-06-23 06:45:46 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
@@ -66,4 +84,8 @@ YAZ_END_CDECL
 #define CAST_ZINT_TO_INT(x) (int)(x)
 #define CAST_ZINT_TO_DOUBLE(x) (double)(x)
 
+/* NATTR=1 for string-attribute architecture, =0 for set+use . */
+#define NATTR 0
+#define REG_TYPE_PREFIX 0
+
 #endif