Back to home page

Enduro/X

 
 

    


0001 BFLDDBUNLINK(3)
0002 ===============
0003 :doctype: manpage
0004 
0005 
0006 NAME
0007 ----
0008 Bflddbunlink - unlink field database files.
0009 
0010 SYNOPSIS
0011 --------
0012 
0013 #include <ubf.h>
0014 
0015 int Bflddbunlink(void);
0016 
0017 Link with '-lubf -lnstd -lm -lpthread'
0018 
0019 DESCRIPTION
0020 -----------
0021 Unlink the database files. This function is useful in cases if configuration
0022 parameters are changed for database. The simple db drop will not cause new
0023 parameters to become in use. Thus when db is closed, it can be unlinked with 
0024 this function. Next access to DB will create new database with new parameters.
0025 
0026 Note this function does not close database handlers. Thus to work properly
0027 the DB shall not be open. Or it should be closed with *Bflddbunload(3)*.
0028 
0029 RETURN VALUE
0030 ------------
0031 On success, *Bflddbunlink()* return zero; on error, -1 is returned, with *Berror* set to 
0032 indicate the error.
0033 
0034 ERRORS
0035 ------
0036 In case of error *Berror* will be non *0*. Note that *Bstrerror()* returns 
0037 generic error message plus custom message with  debug info from last function call.
0038 
0039 *BEUNIX* unlink of data files failed.
0040 
0041 EXAMPLE
0042 -------
0043 See *atmitest/test050_ubfdb/atmiclt50.c* for sample code.
0044 
0045 BUGS
0046 ----
0047 Report bugs to support@mavimax.com
0048 
0049 SEE ALSO
0050 --------
0051 *Bflddbid(3)* *Bflddbname(3)* *Bflddbload(3)* *Bflddbunload(3)*
0052 *Bflddbdrop(3)* *Bflddbdel(3)* *Bflddbadd(3)* *Bflddbget(3)* *ubfdb.ini(5)*
0053 
0054 COPYING
0055 -------
0056 (C) Mavimax, Ltd
0057