MySQL  8.0.18
Source Code Documentation
my_option Struct Reference

#include <my_getopt.h>

Public Attributes

const char * name
 Name of the option. More...
 
int id
 For 0<id<=255 it's means one character for a short option (like -A), if >255 no short option is created, but a long option still can be identified uniquely in the my_get_one_option() callback. More...
 
const char * comment
 option comment, for autom. More...
 
void * value
 A pointer to the variable value. More...
 
void * u_max_value
 The user def. More...
 
TYPELIBtypelib
 Pointer to possible values. More...
 
ulong var_type
 GET_BOOL, GET_ULL, etc. More...
 
enum get_opt_arg_type arg_type
 e.g. More...
 
longlong def_value
 Default value. More...
 
longlong min_value
 Min allowed value (for numbers) More...
 
ulonglong max_value
 Max allowed value (for numbers) More...
 
struct get_opt_arg_sourcearg_source
 Represents source/path from where this variable is set. More...
 
long block_size
 Value should be a mult. More...
 
void * app_type
 To be used by an application. More...
 

Member Data Documentation

◆ app_type

void* my_option::app_type

To be used by an application.

◆ arg_source

struct get_opt_arg_source* my_option::arg_source

Represents source/path from where this variable is set.

◆ arg_type

enum get_opt_arg_type my_option::arg_type

e.g.

REQUIRED_ARG or OPT_ARG

◆ block_size

long my_option::block_size

Value should be a mult.

of this (for numbers)

◆ comment

const char* my_option::comment

option comment, for autom.

–help. if it's NULL the option is not visible in –help.

◆ def_value

longlong my_option::def_value

Default value.

◆ id

int my_option::id

For 0<id<=255 it's means one character for a short option (like -A), if >255 no short option is created, but a long option still can be identified uniquely in the my_get_one_option() callback.

If an opton needs neither special treatment in the my_get_one_option() nor one-letter short equivalent use id=0. id=-1 is a special case and is used to generate deprecation warnings for plugin options. It should not be used for anything else.

◆ max_value

ulonglong my_option::max_value

Max allowed value (for numbers)

◆ min_value

longlong my_option::min_value

Min allowed value (for numbers)

◆ name

const char* my_option::name

Name of the option.

name=NULL marks the end of the my_option[] array.

◆ typelib

TYPELIB* my_option::typelib

Pointer to possible values.

◆ u_max_value

void* my_option::u_max_value

The user def.

max variable value

◆ value

void* my_option::value

A pointer to the variable value.

◆ var_type

ulong my_option::var_type

GET_BOOL, GET_ULL, etc.


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