User manual

126
This method is used to define if option value is hidden, i.e. not accessible for view/change.
It wraps routine identified by the is_option_value_hidden entry of chapi_in communication
context.
chapi_cfg_option_t class derivatives
CHAPI protocol supports three different types of options: integer, boolean and string. For
each kind of option dedicated wrapper is implemented.
Integer options are wrapped by the C++ class chapi_integer_option_t derived from the class
chapi_cfg_option_t. The following public methods defined:
chapi_integer_option_t(const struct __chapi_in * ci, const char *opt_name,
int opt_vals_count);
сhapi_integer_option_t(const chapi_cfg_option_t &option);
where
ci - pointer to chapi_in communication context supplied during the
loadable component initialization;
opt_name - option name to create;
opt_vals_count - the number of option values within the option;
option - reference to the option which should be used for initialization.
These constructors are used to create integer option.
chapi_integer_option_value_t & operator[] (int idx);
where
idx - index of option value to access.
This operator is used to access option values by index. Reference to the integer option
value with specified index is returned.
Boolean options are wrapped by the C++ class chapi_bool_option_t derived from the class
chapi_cfg_option_t. The following public methods defined:
chapi_bool_option_t(const struct __chapi_in * ci, const char *opt_name,
int opt_vals_count);
сhapi_bool_option_t(const chapi_cfg_option_t &option);
where