Back to home page

Enduro/X

 
 

    


0001 BVNULL(3)
0002 =========
0003 :doctype: manpage
0004 
0005 
0006 NAME
0007 ----
0008 Bvnull - Test is structure field have a NULL value according to the view
0009 
0010 
0011 SYNOPSIS
0012 --------
0013 
0014 #include <ubf.h>
0015 
0016 int Bvnull(char *'cstruct', char *'cname', BFLDOCC 'occ', char *'view');
0017 
0018 Link with '-lubf -lnstd -lm -lpthread'
0019 
0020 DESCRIPTION
0021 -----------
0022 
0023 Test is field in structure NULL. The tests are done by comparing the field value
0024 with 'NULL' value column defined in view file. Note that if 'NULL' was set to
0025 *NONE*, then function will always return *FALSE*. The pointer to structure 
0026 is given in 'cstruct'. The field name is specified in 'cname'. The array element
0027 index (zero based) is passed in 'occ' field. If 'COUNT' is set to 1 in view file,
0028 then field is tested via occ set to *0*.
0029 
0030 RETURN VALUE
0031 ------------
0032 If field is NULL, *Bvnull()* return *1*; If field is no NULL, function returns *0*;
0033 on error, -1 is returned, with *Berror* set to indicate the error.
0034 
0035 ERRORS
0036 ------
0037 Note that *Bstrerror()* returns generic error message plus custom message with 
0038 debug info from last function call.
0039 
0040 *BEINVAL* Invalid value passed to function, parameters are NULL or invalid 'occ'
0041 index.
0042 
0043 *BNOCNAME* Invalid 'cname' specified (field not found).
0044 
0045 *BBADVIEW* View is not found, object file is defective or system error.
0046 
0047 
0048 EXAMPLE
0049 -------
0050 See *atmitest/test040_typedview/viewunit1.c* for sample code.
0051 
0052 BUGS
0053 ----
0054 Report bugs to support@mavimax.com
0055 
0056 SEE ALSO
0057 --------
0058 *viewc(8)* *Bvstof(3)* *Bvftos(3)* *Bvsinit(3)* *Bvselinit(3)* *Bvnull(3)* *ex_env(5)*
0059 *Bupdate(3)* *Bconcat(3)*
0060 
0061 COPYING
0062 -------
0063 (C) Mavimax, Ltd
0064