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