Back to home page

Enduro/X

 
 

    


0001 Bojoin(3)
0002 =========
0003 :doctype: manpage
0004 
0005 
0006 NAME
0007 ----
0008 Bojoin - outer join source buffer into destination buffer
0009 
0010 
0011 SYNOPSIS
0012 --------
0013 
0014 #include <ubf.h>
0015 
0016 int Bojoin(UBFH *'dest', UBFH *'src');
0017 
0018 Link with '-lubf -lnstd -lm -lpthread'
0019 
0020 DESCRIPTION
0021 -----------
0022 Bojoin function is similar to Bjoin function.
0023 Outer join function updates destination buffer in 'dest' with source buffer 'src' 
0024 values based on matching fields and occurrence. Function will update existing 
0025 fields from source buffer to destination with matching occurrences. If field 
0026 does not exist or occurrence does not exists, then field/occurrence is not removed 
0027 from destination buffer. By comparing to *Bupdate(3)*, this function updates only
0028 matched fields, and does not add any missing as it is done by *Bupdate(3)*. By
0029 comparing to *Bjoin(3)*, *Bjoin(3)* will remove not matched fields from 'dest',
0030 but *Bojoin()* will leave dest fields non deleted.
0031 
0032 
0033 RETURN VALUE
0034 ------------
0035 On success, *Bojoin()* return zero; on error, -1 is returned, with *Berror* set 
0036 to indicate the error.
0037 
0038 
0039 ERRORS
0040 ------
0041 Bstrerror(3) can give more description for error (for last call).
0042 
0043 *BALIGNERR* Corrupted buffer or pointing to not aligned memory area.
0044 
0045 *BNOTFLD* Buffer not fielded, not correctly allocated or corrupted. 
0046 dest or src is NULL.
0047 
0048 *FBADFLD* Invalid field type.
0049 
0050 EXAMPLE
0051 -------
0052 See *ubftest/test_bojoin.c* for sample code.
0053 
0054 BUGS
0055 ----
0056 Report bugs to support@mavimax.com
0057 
0058 SEE ALSO
0059 --------
0060 *Boccur(3)* *Bpres(3)* *Bjoin(3)*
0061 
0062 COPYING
0063 -------
0064 (C) Mavimax, Ltd
0065 
0066