updated Doxyfile
[strongswan.git] / src / libstrongswan / utils / optionsfrom.h
1 /*
2 * Copyright (C) 2007-2008 Andreas Steffen
3 *
4 * Hochschule fuer Technik Rapperswil
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * for more details.
15 *
16 * $Id$
17 */
18
19 /**
20 * @defgroup optionsfrom optionsfrom
21 * @{ @ingroup utils
22 */
23
24 #ifndef OPTIONSFROM_H_
25 #define OPTIONSFROM_H_
26
27 typedef struct options_t options_t;
28
29 /**
30 * Reads additional command line arguments from a file
31 */
32 struct options_t {
33
34 /**
35 * Check if the PKCS#7 contentType is data
36 *
37 * @param filename file containing the options
38 * @param argcp pointer to argc
39 * @param argvp pointer to argv[]
40 * @param optind current optind, number of next argument
41 * @return TRUE if optionsfrom parsing successful
42 */
43 bool (*from) (options_t * this, char *filename,
44 int *argcp, char **argvp[], int optind);
45
46 /**
47 * Destroys the options_t object.
48 */
49 void (*destroy) (options_t *this);
50 };
51
52 /**
53 * Create an options object.
54 *
55 * @return created options_t object
56 */
57 options_t *options_create(void);
58
59 #endif /** OPTIONSFROM_H_ @}*/