0001 BFLDDBLOAD(3)
0002 =============
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 Bflddbload - load UBF custom field database manually
0009
0010
0011 SYNOPSIS
0012 --------
0013
0014 #include <ubf.h>
0015
0016 int Bflddbload(void);
0017
0018 Link with '-lubf -lnstd -lm -lpthread'
0019
0020 DESCRIPTION
0021 -----------
0022 Load (and open EXDB/LMDB) handlers to the UBF custom field storage database.
0023 This function is automatically called when accessing UBF commands which require
0024 field tables, for converting field IDs to string names and vice versa.
0025
0026 This function could be useful in cases when manually closing the database
0027 by *Bflddbunload(3)*, performing unlink by *Bflddbunlink(3)* and then opening
0028 the handlers again. Because in cases if UBF standard functions already pulled
0029 in the init of field tables, it will not do it again.
0030
0031 RETURN VALUE
0032 ------------
0033 On success, *Bflddbload()* returns *1* (meaning common-configuration (CC)
0034 and '[@ubfdb]' section found. Function returns *0* in case if CC configuration
0035 not found or '[@ubfdb]' configuration section is not found. In case of error
0036 *-1* is returned.
0037
0038 ERRORS
0039 ------
0040 In case of error *Berror* will be non *0*. Note that *Bstrerror()* returns
0041 generic error message plus custom message with debug info from last function call.
0042
0043 *BEINVAL* 'resource' parameter is missing for '[@ubfdb]' section.
0044
0045 *BMALLOC* malloc failed.
0046
0047 *BEUNIX* failed to load ini file(s). EXDB failed.
0048
0049 *BNOSPACE* lmdb max readers reached or other limit, see logs for details.
0050
0051 EXAMPLE
0052 -------
0053 See *atmitest/test050_ubfdb/atmiclt50.c* for sample code.
0054
0055 BUGS
0056 ----
0057 Report bugs to support@mavimax.com
0058
0059 SEE ALSO
0060 --------
0061 *Bflddbid(3)* *Bflddbname(3)* *Bflddbget(3)* *Bflddbunload(3)*
0062 *Bflddbdrop(3)* *Bflddbdel(3)* *Bflddbadd(3)* *Bflddbunlink(3)* *ubfdb.ini(5)*
0063
0064 COPYING
0065 -------
0066 (C) Mavimax, Ltd
0067
