0001 BVOPT(3)
0002 ========
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 Bvopt - Change the view field options
0009
0010
0011 SYNOPSIS
0012 --------
0013
0014 #include <ubf.h>
0015
0016 int Bvopt(char *'cname', int 'option', char *'view');
0017
0018 Link with '-lubf -lnstd -lm -lpthread'
0019
0020 DESCRIPTION
0021 -----------
0022 Function is used to change the field options for loaded view. This affects only
0023 the runtime session and after the program reboot the flags are read from object
0024 files. Flags that can be changed in the view are related to data copy to/from
0025 UBF buffer. The field name is specified into 'cname', the view name is specified
0026 in the 'view' field. Function is thread safe (i.e. to threads can call the Bvopt
0027 concurrently, but last one will take an effect).
0028
0029 The 'option' field can take following values (constants from 'ubf.h'):
0030
0031 . *B_FTOS* - same as *S* flag in view file. One way copy from UBF to struct, i.e.
0032 this field will participate in *Bvftos(3)*.
0033
0034 . *B_STOF* - same as *F* flag in view file. One way copy from struct to UBF buffer.
0035 This field will participate in *Bvstof(3)*.
0036
0037 . *B_OFF* - same as *N* flag in view file. Field will not participate in the
0038 *Bvftos(3)* or *Bvstof(3)* operations.
0039
0040 . *B_BOTH* - sames as both flags *F* and *S* set, field will participate in
0041 *Bvftos(3)* and *Bvstof(3)*.
0042
0043 RETURN VALUE
0044 ------------
0045 On success, *Bvftos()* return zero; on error, -1 is returned, with *Berror* set to
0046 indicate the error.
0047
0048 ERRORS
0049 ------
0050 Note that *Bstrerror()* returns generic error message plus custom message with
0051 debug info from last function call.
0052
0053 *BEINVAL* Invalid value passed to function, parameters are NULL or invalid 'option'.
0054
0055 *BNOCNAME* Invalid 'cname' specified (field not found).
0056
0057 *BBADVIEW* View is not found, object file is defective or system error.
0058
0059
0060 EXAMPLE
0061 -------
0062 See *atmitest/test040_typedview/viewunit1.c* for sample code.
0063
0064 BUGS
0065 ----
0066 Report bugs to support@mavimax.com
0067
0068 SEE ALSO
0069 --------
0070 *viewc(8)* *Bvstof(3)* *Bvftos(3)* *Bvsinit(3)* *Bvselinit(3)* *Bvnull(3)* *ex_env(5)*
0071 *Bupdate(3)* *Bconcat(3)*
0072
0073 COPYING
0074 -------
0075 (C) Mavimax, Ltd
0076
