MySQL 9.1.0
Source Code Documentation
Variable

definitions More...

Macros

#define INTEGRAL_CHECK_ARG(type)
 Defines an integral placeholder to fill in with values and pass to the registration function. More...
 
#define ENUM_CHECK_ARG(type)
 Defines an TYPE_LIB placeholder to fill in with values and pass to the registration function. More...
 
#define BOOL_CHECK_ARG(type)
 Defines a bool placeholder to fill in with values and pass to the registration function. More...
 
#define STR_CHECK_ARG(type)
 Defines a char * placeholder to fill in with values and pass to the registration function. More...
 

Detailed Description

definitions

You need to fill one of these in an pass it to the registration function. The values are copied so this doesn't have to survive once the registration call is done. So usually it's done as an automatic variable in the stack.

Make sure to use the right one for your variable type. See Variable types for what to use for the individual types.

See also
mysql_service_component_sys_variable_register service.

Macro Definition Documentation

◆ BOOL_CHECK_ARG

#define BOOL_CHECK_ARG (   type)
Value:
struct type##_check_arg_s { \
bool def_val; \
}
required string type
Definition: replication_group_member_actions.proto:34

Defines a bool placeholder to fill in with values and pass to the registration function.

Make sure to fill in def_val.

◆ ENUM_CHECK_ARG

#define ENUM_CHECK_ARG (   type)
Value:
struct type##_check_arg_s { \
unsigned long def_val; \
TYPE_LIB *typelib; \
}

Defines an TYPE_LIB placeholder to fill in with values and pass to the registration function.

Make sure to fill in def_val and typelib.

◆ INTEGRAL_CHECK_ARG

#define INTEGRAL_CHECK_ARG (   type)
Value:
struct type##_check_arg_s { \
type def_val; \
type min_val; \
type max_val; \
type blk_sz; \
}

Defines an integral placeholder to fill in with values and pass to the registration function.

Make sure to fill in def_val, min_val, max_val and blk_sz.

◆ STR_CHECK_ARG

#define STR_CHECK_ARG (   type)
Value:
struct type##_check_arg_s { \
char *def_val; \
}

Defines a char * placeholder to fill in with values and pass to the registration function.

Make sure to fill in def_val.