Back to home page

Enduro/X

 
 

    


0001 BFLDDBGET(3)
0002 =============
0003 :doctype: manpage
0004 
0005 
0006 NAME
0007 ----
0008 Bflddbget - extract data from UBF database record
0009 
0010 
0011 SYNOPSIS
0012 --------
0013 
0014 #include <ubf.h>
0015 
0016 int Bflddbget(EDB_val *'data', short *'p_fldtype',
0017         BFLDID *'p_bfldno', BFLDID *'p_bfldid', char *'fldname', int 'fldname_bufsz');
0018 
0019 Link with '-lubf -lnstd -lm -lpthread'
0020 
0021 DESCRIPTION
0022 -----------
0023 Function extracts UBF field data from database record. The record can be extracted
0024 either from id database or name (nm) database. The field type is stored
0025 in 'p_fldtype' which corresponds to BFLD_MIN...BFLD_MAX field types. 
0026 Field number (non compiled) is return in 'p_bfldno', field id (compiled) is
0027 returned in 'p_bfldid'. Field name is returned in 'fldname' for which
0028 buffer size is specified in 'fldname_bufsz'.
0029 
0030 RETURN VALUE
0031 ------------
0032 On success, *Bflddbget()* return zero; on error, -1 is returned, with *Berror* set to 
0033 indicate the error.
0034 
0035 ERRORS
0036 ------
0037 In case of error *Berror* will be non *0*. Note that *Bstrerror()* returns 
0038 generic error message plus custom message with  debug info from last function call.
0039 
0040 *BEINVAL* 'data' is NULL, 'p_bfldno' is NULL, 'p_bfldid' is NULL, 'p_fldtype'
0041 is NULL, 'fldname' is NULL, 'fldname_bufsz' less than or equal to *0*. Error
0042 can be generated also if 'data' is corrupted (size does not match the stored
0043 object size).
0044 
0045 EXAMPLE
0046 -------
0047 See *xadmin/cmd_pubfdb.c* for sample code.
0048 
0049 BUGS
0050 ----
0051 Report bugs to support@mavimax.com
0052 
0053 SEE ALSO
0054 --------
0055 *Bflddbid(3)* *Bflddbname(3)* *Bflddbload(3)* *Bflddbunload(3)*
0056 *Bflddbdrop(3)* *Bflddbdel(3)* *Bflddbadd(3)* *Bflddbunlink(3)* *ubfdb.ini(5)*
0057 
0058 COPYING
0059 -------
0060 (C) Mavimax, Ltd
0061