MySQL  8.0.18
Source Code Documentation
system_variable_source.h
Go to the documentation of this file.
1 /* Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved.
2 
3 This program is free software; you can redistribute it and/or modify
4 it under the terms of the GNU General Public License, version 2.0,
5 as published by the Free Software Foundation.
6 
7 This program is also distributed with certain software (including
8 but not limited to OpenSSL) that is licensed under separate terms,
9 as designated in a particular file or component or in included license
10 documentation. The authors of MySQL hereby grant you an additional
11 permission to link the program and your derivative works with the
12 separately licensed software that they have included with MySQL.
13 
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License, version 2.0, for more details.
18 
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22 
23 #ifndef SYSTEM_VARIABLE_SOURCE_H
24 #define SYSTEM_VARIABLE_SOURCE_H
25 
28 
29 /**
30  A service to deal with source of system variable. A system variable
31  could be set from different sources for eg: Command line, Configuration
32  file etc. This service exposes method to get the source information of
33  a given system variable.
34 */
35 BEGIN_SERVICE_DEFINITION(system_variable_source)
36 
37 /**
38  Get source information of given system variable.
39 
40  @param [in] name Name of sytem variable in system charset
41  @param [in] length Name length of sytem variable
42  @param [out] source Source of system variable
43  @return Status of performance operation
44  @retval false Success
45  @retval true Failure
46 */
47 
48 DECLARE_BOOL_METHOD(get, (const char *name, unsigned int length,
49  enum enum_variable_source *source));
50 
51 END_SERVICE_DEFINITION(system_variable_source)
52 
53 #endif /* SYSTEM_VARIABLE_SOURCE_H */
const string name("\ame\)
enum_variable_source
This enum values define how system variables are set.
Definition: system_variable_source_type.h:32
#define DECLARE_BOOL_METHOD(name, args)
#define BEGIN_SERVICE_DEFINITION(name)
#define END_SERVICE_DEFINITION(name)
bool length(const dd::Spatial_reference_system *srs, const Geometry *g1, double *length, bool *null) noexcept
Computes the length of linestrings and multilinestrings.
Definition: length.cc:75