-Record rec_cp (Record rec);
-void rec_rm (Record rec);
-void rec_put (Records p, Record rec);
-Record rec_new (Records p);
-Record rec_get (Records p, int sysno);
-void rec_close (Records *p);
-Records rec_open (int rw);
-char *rec_strdup (const char *s);
+/** \brief marks record for deletion (on file storage)
+ \param p records handle
+ \param recpp record pointer
+ \returns ZEBRA_OK / ZEBRA_FAIL
+*/
+ZEBRA_RES rec_del(Records p, Record *recpp);
+
+/** \brief frees record (from memory)
+ \param recpp record pointer
+*/
+void rec_free(Record *recpp);
+
+/** \brief puts record (writes into file storage)
+ \param p records handle
+ \param recpp record pointer
+ \returns ZEBRA_OK / ZEBRA_FAIL
+*/
+ZEBRA_RES rec_put(Records p, Record *recpp);
+
+/** \brief creates new record (to be written to file storage)
+ \param p records handle
+ \returns record pointer (or NULL on error)
+*/
+Record rec_new(Records p);
+/** \brief gets record - with given system number
+ \param p records handle
+ \param sysno system ID (external number)
+ \returns record pointer (or NULL on error)
+*/
+Record rec_get(Records p, zint sysno);
+
+/** \brief gets root record
+ \param p records handle
+ \returns record pointer (or NULL on error)
+*/
+Record rec_get_root(Records p);
+ZEBRA_RES rec_close (Records *p);
+
+/** \brief opens records system
+ \param bfs block file storage
+ \param rw read-write flag(0=read only, 1=write)
+ \param compression_method REC_COMPRESS_ type
+*/
+Records rec_open(BFiles bfs, int rw, int compression_method);
+
+char *rec_strdup(const char *s, size_t *len);
+void rec_prstat(Records p);
+
+zint rec_sysno_to_int(zint sysno);
+
+/** \brief compression types */
+#define REC_COMPRESS_NONE 0
+#define REC_COMPRESS_BZIP2 1
+
+enum {
+ recInfo_fileType,
+ recInfo_filename,
+ recInfo_delKeys,
+ recInfo_databaseName,
+ recInfo_storeData,
+ recInfo_attr,
+ recInfo_sortKeys
+};
+
+YAZ_END_CDECL
+#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+