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