-/* $Id: bfile.h,v 1.11 2006-11-08 22:08:26 adam Exp $
- Copyright (C) 1995-2006
- Index Data ApS
-
-This file is part of the Zebra server.
+/* This file is part of the Zebra server.
+ Copyright (C) 2004-2013 Index Data
Zebra is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
/** \brief destroys a block files handle
\param bfiles block files handle
-
+
The files in the block files collection are not deleted. Only the
- handle is
+ handle is freed.
*/
void bfs_destroy (BFiles bfiles);
+/** \brief closes a Block file (may call exit)
+ \param bf block file
+ */
+YAZ_EXPORT
+void bf_close(BFile bf);
+
/** \brief closes a Block file
\param bf block file
+ \retval 0 success
+ \retval -1 failure
*/
YAZ_EXPORT
-int bf_close (BFile bf);
+int bf_close2(BFile bf);
/** \brief closes an extended Block file handle..
\param bf extended block file opened with bf_xopen
\param version version to be put in a file
\param more_info more information to be stored in file (header)
- \retval 0 succes
+ \retval 0 success
\retval -1 failure (can never happen as the code is now)
-*/
+*/
YAZ_EXPORT
-int bf_xclose (BFile bf, int version, const char *more_info);
+int bf_xclose(BFile bf, int version, const char *more_info);
/** \brief opens and returns a Block file handle
\param bfs block files
\param name filename
\param block_size block size in bytes
\param wflag 1=opened for read&write, 0=read only
- \retval 0 succes
+ \retval 0 success
\retval -1 failure (can never happen as the code is now)
*/
YAZ_EXPORT
-BFile bf_open (BFiles bfs, const char *name, int block_size, int wflag);
+BFile bf_open(BFiles bfs, const char *name, int block_size, int wflag);
/** \brief opens and returns an extended Block file handle
\param bfs block files
\retval -1 error
*/
YAZ_EXPORT
-int bf_read2(BFile bf, zint no, int offset, int nbytes, void *buf);
+int bf_read2(BFile bf, zint no, int offset, int nbytes, void *buf)
+ ZEBRA_GCC_ATTR((warn_unused_result));
/** \brief writes block of bytes to file (may call exit)
if write failed.
*/
YAZ_EXPORT
-int bf_write2(BFile bf, zint no, int offset, int nbytes, const void *buf);
-
+int bf_write2(BFile bf, zint no, int offset, int nbytes, const void *buf)
+ ZEBRA_GCC_ATTR((warn_unused_result));
/** \brief enables or disables shadow for block files
\param bfs block files
\param bfs block files
*/
YAZ_EXPORT
-void bf_commitExec (BFiles bfs);
+int bf_commitExec (BFiles bfs) ZEBRA_GCC_ATTR((warn_unused_result));
/** \brief Cleans shadow files (remove them)
\param bfs block files
on same platform depending on whether 64-bit is enabled or not.
Note that if a shadow area has unlimited size, that is represented
as max_bytes = -1.
-*/
+*/
YAZ_EXPORT
int bfs_shadow_directory_stat(BFiles bfs, int no, const char **directory,
double *used_bytes, double *max_bytes);
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab