Back to home page

Enduro/X

 
 

    


0001 BVSETOCCUR(3)
0002 =============
0003 :doctype: manpage
0004 
0005 
0006 NAME
0007 ----
0008 Bvsetoccur - Set occurrences of the view count field
0009 
0010 
0011 SYNOPSIS
0012 --------
0013 
0014 #include <ubf.h>
0015 
0016 int Bvsetoccur(char *'cstruct', char *'view', char *'cname', BFLDOCC 'occ');
0017 
0018 Link with '-lubf -lnstd -lm -lpthread'
0019 
0020 DESCRIPTION
0021 -----------
0022 Function is used to set array length in the 'C_<field>' (count field) if configured
0023 in view file with flag 'C'. If flag is not used in view (count field not present
0024 in view) then function will just return succeed without changing anything.
0025 
0026 RETURN VALUE
0027 ------------
0028 On success, *Bvsetoccur()* return zero; on error, -1 is returned, with *Berror* set to 
0029 indicate the error.
0030 
0031 ERRORS
0032 ------
0033 Note that *Bstrerror()* returns generic error message plus custom message with debug info 
0034 from last function call, stored in thread local storage (TLS).
0035 
0036 *BEINVAL* 'view', 'cstruct' or 'cname' is NULL. 'view' or 'cname' is empty string (first byte
0037 0x00). Or occurrence is out of bounds of the array declaration.
0038 
0039 *BBADVIEW* invalid view name (not found in view file).
0040 
0041 *BNOCNAME* field name ('cname') not found in view structure.
0042 
0043 EXAMPLE
0044 -------
0045 See *atmitest/test040_typedview/vaccutil.c* for sample code.
0046 
0047 BUGS
0048 ----
0049 Report bugs to support@mavimax.com
0050 
0051 SEE ALSO
0052 --------
0053 *CBvchg(3)* *CBvget(3)* *Bvnext(3)* *viewfile(5)*
0054 
0055 COPYING
0056 -------
0057 (C) Mavimax, Ltd
0058