my_option Struct Reference

Collaboration diagram for my_option:

Public Attributes
const char *	name
int	id
const char *	comment
void *	value
void *	u_max_value
struct st_typelib *	typelib
ulong	var_type
enum get_opt_arg_type	arg_type
longlong	def_value
longlong	min_value
ulonglong	max_value
longlong	sub_size
long	block_size
void *	app_type

Detailed Description

Definition at line 55 of file my_getopt.h.

Member Data Documentation

void* my_option::app_type

To be used by an application

Definition at line 90 of file my_getopt.h.

enum get_opt_arg_type my_option::arg_type

e.g. REQUIRED_ARG or OPT_ARG

Definition at line 84 of file my_getopt.h.

long my_option::block_size

Value should be a mult. of this (for numbers)

Definition at line 89 of file my_getopt.h.

const char* my_option::comment

option comment, for autom. –help. if it's NULL the option is not visible in –help.

Definition at line 76 of file my_getopt.h.

longlong my_option::def_value

Default value

Definition at line 85 of file my_getopt.h.

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.

Definition at line 61 of file my_getopt.h.

ulonglong my_option::max_value

Max allowed value (for numbers)

Definition at line 87 of file my_getopt.h.

longlong my_option::min_value

Min allowed value (for numbers)

Definition at line 86 of file my_getopt.h.

const char* my_option::name

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

Definition at line 57 of file my_getopt.h.

longlong my_option::sub_size

Unused

Definition at line 88 of file my_getopt.h.

struct st_typelib* my_option::typelib

Pointer to possible values

Definition at line 82 of file my_getopt.h.

void* my_option::u_max_value

The user def. max variable value

Definition at line 81 of file my_getopt.h.

void* my_option::value

A pointer to the variable value

Definition at line 80 of file my_getopt.h.

ulong my_option::var_type

GET_BOOL, GET_ULL, etc

Definition at line 83 of file my_getopt.h.

---

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

• include/my_getopt.h