Extend reassembly documentation
[metze/wireshark/wip.git] / epan / ex-opt.h
1 /*
2  *  ex-opt.h
3  *
4  * eXtension command line options
5  *
6  * (c) 2006, Luis E. Garcia Ontanon <luis@ontanon.org>
7  *
8  * Wireshark - Network traffic analyzer
9  * By Gerald Combs <gerald@wireshark.org>
10  * Copyright 1998 Gerald Combs
11  *
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25  */
26
27 #ifndef _EX_OPT_H
28 #define _EX_OPT_H
29
30 #include "ws_symbol_export.h"
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif /* __cplusplus */
35
36 /* will be called by main each time a -X option is found */
37 WS_DLL_PUBLIC gboolean ex_opt_add(const gchar* optarg);
38
39 /* yields the number of arguments of a given key obviously returns 0 if there aren't */
40 WS_DLL_PUBLIC gint ex_opt_count(const gchar* key);
41
42 /* fetches the nth argument of a given key returns NULL if there isn't */
43 WS_DLL_PUBLIC const gchar* ex_opt_get_nth(const gchar* key, guint index);
44
45 /* extracts the next value of a given key */
46 WS_DLL_PUBLIC const gchar* ex_opt_get_next(const gchar* key);
47
48 #ifdef __cplusplus
49 }
50 #endif /* __cplusplus */
51
52 #endif /* _EX_OPT_H */