Sys_var_enum Class Reference

#include <sys_vars.h>

Inheritance diagram for Sys_var_enum:

List of all members.

Public Member Functions
	Sys_var_enum (const char *name_arg, const char *comment, int flag_args, ptrdiff_t off, size_t size, CMD_LINE getopt, const char *values[], uint def_val, PolyLock *lock=0, enum binlog_status_enum binlog_status_arg=VARIABLE_NOT_IN_BINLOG, on_check_function on_check_func=0, on_update_function on_update_func=0, const char *substitute=0)
bool	session_update (THD *thd, set_var *var)
bool	global_update (THD *thd, set_var *var)
void	session_save_default (THD *thd, set_var *var)
void	global_save_default (THD *thd, set_var *var)
uchar *	session_value_ptr (THD *thd, LEX_STRING *base)
uchar *	global_value_ptr (THD *thd, LEX_STRING *base)

---

Detailed Description

The class for ENUM variables - variables that take one value from a fixed list of values.

Class specific constructor arguments: char* values[] - 0-terminated list of strings of valid values

Backing store: uint

Note:

Do *not* use "enum FOO" variables as a backing store, there is no guarantee that sizeof(enum FOO) == sizeof(uint), there is no guarantee even that sizeof(enum FOO) == sizeof(enum BAR)

---

Member Function Documentation

void Sys_var_enum::global_save_default	(	THD *	thd,
		set_var *	var
	)		[inline, virtual]

save the global default value of the variable in var

Implements sys_var.

void Sys_var_enum::session_save_default	(	THD *	thd,
		set_var *	var
	)		[inline, virtual]

save the session default value of the variable in var

Implements sys_var.

uchar* Sys_var_enum::session_value_ptr	(	THD *	thd,
		LEX_STRING *	base
	)		[inline, virtual]

A pointer to a value of the variable for SHOW. It must be of show_val_type type (bool for SHOW_BOOL, int for SHOW_INT, longlong for SHOW_LONGLONG, etc).

Reimplemented from sys_var.

---

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

• sys_vars.h