epan/ex-opt.h

   1 /** @file
   2  *
   3  * eXtension command line options
   4  *
   5  * (c) 2006, Luis E. Garcia Ontanon <luis@ontanon.org>
   6  *
   7  * Wireshark - Network traffic analyzer
   8  * By Gerald Combs <gerald@wireshark.org>
   9  * Copyright 1998 Gerald Combs
  10  *
  11  * SPDX-License-Identifier: GPL-2.0-or-later
  12  */
  13
  14 #ifndef _EX_OPT_H
  15 #define _EX_OPT_H
  16
  17 #include <stdbool.h>
  18
  19 #include "ws_symbol_export.h"
  20
  21 #ifdef __cplusplus
  22 extern "C" {
  23 #endif /* __cplusplus */
  24
  25 /* will be called by main each time a -X option is found */
  26 WS_DLL_PUBLIC bool ex_opt_add(const char* ws_optarg);
  27
  28 /* yields the number of arguments of a given key obviously returns 0 if there aren't */
  29 WS_DLL_PUBLIC int ex_opt_count(const char* key);
  30
  31 /* fetches the nth argument of a given key returns NULL if there isn't */
  32 WS_DLL_PUBLIC const char* ex_opt_get_nth(const char* key, unsigned key_index);
  33
  34 /* extracts the next value of a given key */
  35 WS_DLL_PUBLIC const char* ex_opt_get_next(const char* key);
  36
  37 #ifdef __cplusplus
  38 }
  39 #endif /* __cplusplus */
  40
  41 #endif /* _EX_OPT_H */