Ubuntu Platform API  1.2.0
A library helping with tight integration into the Ubuntu platform
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
options.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Ricardo Mendoza <ricardo.mendoza@canonical.com>
17  * Thomas Voß <thomas.voss@canonical.com>
18  */
19 
20 #ifndef UBUNTU_APPLICATION_OPTIONS_H_
21 #define UBUNTU_APPLICATION_OPTIONS_H_
22 
23 #include <ubuntu/visibility.h>
24 
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
35  typedef void UApplicationOptions;
36 
44  UBUNTU_DLL_PUBLIC UApplicationOptions*
46  int argc,
47  char** argv);
48 
56  UApplicationOptions *options);
57 
66  UApplicationOptions *options);
67 
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif /* UBUNTU_APPLICATION_OPTIONS_H_ */
UApplicationOperationMode
Describes the different operational modes that an application can run in.
UBUNTU_DLL_PUBLIC UApplicationOptions * u_application_options_new_from_cmd_line(int argc, char **argv)
Parses options from the command line.
UBUNTU_DLL_PUBLIC void u_application_options_destroy(UApplicationOptions *options)
Destroys the options object and releases all resources.
void UApplicationOptions
Encapsulates options as passed to the application.
Definition: options.h:35
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:25
UBUNTU_DLL_PUBLIC UApplicationOperationMode u_application_options_get_operation_mode(UApplicationOptions *options)
Queries the operation mode from the supplied options object.