An implementation of the configuration system variables Service to register variable and unregister variable. More...

Static Public Member Functions
static mysql_service_status_t	register_variable (const char component_name, const char var_name, int flags, const char comment, mysql_sys_var_check_func check_func, mysql_sys_var_update_func update_func, void check_arg, void *variable_value) noexcept
	Register's component system variables. More...

static mysql_service_status_t	get_variable (const char component_name, const char var_name, void *val, size_t out_length_of_val) noexcept
	Get the component system variable value from the global structure. More...

static mysql_service_status_t	unregister_variable (const char component_name, const char var_name) noexcept
	Unregister's component system variable. More...

Detailed Description

An implementation of the configuration system variables Service to register variable and unregister variable.

Member Function Documentation

mysql_service_status_t mysql_component_sys_variable_imp::get_variable	(	const char *	component_name,
		const char *	var_name,
		void **	val,
		size_t *	out_length_of_val
	)

staticnoexcept

Get the component system variable value from the global structure.

Parameters

	component_name	Name of the component
	var_name	Name of the variable
[in,out]	val	On input: a buffer to hold the value. On output a pointer to the value.
[in,out]	out_length_of_val	On input: size of longest string that the buffer can contain. On output the length of the copied string.

Return values

false	success
true	failure

mysql_service_status_t mysql_component_sys_variable_imp::register_variable	(	const char *	component_name,
		const char *	var_name,
		int	flags,
		const char *	comment,
		mysql_sys_var_check_func	check_func,
		mysql_sys_var_update_func	update_func,
		void *	check_arg,
		void *	variable_value
	)

staticnoexcept

Register's component system variables.

Parameters

component_name	name of the component
var_name	variable name
flags	tells about the variable type
comment	variable comment message
check_func	function pointer, which is called at variable check time
update_func	function pointer, which is called at update time
check_arg	type defined check constraints block
variable_value	place holder for variable value

Return values

false	success
true	failure

mysql_service_status_t mysql_component_sys_variable_imp::unregister_variable	(	const char *	component_name,
		const char *	var_name
	)

staticnoexcept

Unregister's component system variable.

Parameters

component_name	name of the component
var_name	Variable name

Return values

false	success
true	failure

The documentation for this class was generated from the following files: