MySQL 8.2.0
Source Code Documentation
char_array_option.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2014, 2023, Oracle and/or its affiliates.
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License, version 2.0,
6 as published by the Free Software Foundation.
7
8 This program is also distributed with certain software (including
9 but not limited to OpenSSL) that is licensed under separate terms,
10 as designated in a particular file or component or in included license
11 documentation. The authors of MySQL hereby grant you an additional
12 permission to link the program and your derivative works with the
13 separately licensed software that they have included with MySQL.
14
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License, version 2.0, for more details.
19
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23*/
24
25#ifndef CHAR_ARRAY_OPTION_INCLUDED
26#define CHAR_ARRAY_OPTION_INCLUDED
27
29
30namespace Mysql {
31namespace Tools {
32namespace Base {
33namespace Options {
34
35/**
36 Option class to get string parameter value and set to char* type object.
37 */
39 public:
40 /**
41 Constructs new string option.
42 @param value Pointer to char* object to receive option value.
43 @param allocated Specifies if value set should be some static string or
44 dynamically allocated string with my_strdup.
45 @param name Name of option. It is used in command line option name as
46 --name.
47 @param description Description of option to be printed in --help.
48 */
49 Char_array_option(char **value, bool allocated, std::string name,
50 std::string description);
51
52 /**
53 Sets value for this option. If it is specified before handling commandline
54 options then supplied value is used as default value of this option.
55 */
56 Char_array_option *set_value(char *value);
57};
58
59} // namespace Options
60} // namespace Base
61} // namespace Tools
62} // namespace Mysql
63
64#endif
Abstract option to handle options accepting value argument.
Definition: abstract_value_option.h:42
Option class to get string parameter value and set to char* type object.
Definition: char_array_option.h:38
Char_array_option * set_value(char *value)
Sets value for this option.
Definition: char_array_option.cc:39
Char_array_option(char **value, bool allocated, std::string name, std::string description)
Constructs new string option.
Definition: char_array_option.cc:32
constexpr pos_type Options
Definition: http_request.h:260
Definition: abstract_connection_program.h:39
case opt name
Definition: sslopt-case.h:32