capture_combo_utils.h

   1 /* capture_combo_utils.c
   2  * Declarations of tilities for combo box of interface names
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifndef __CAPTURE_COMBO_UTILS_H__
  26 #define __CAPTURE_COMBO_UTILS_H__
  27
  28 /** @file
  29  *  GList of available capture interfaces.
  30  */
  31
  32 /** Build the GList of available capture interfaces.
  33  *
  34  * @param if_list An interface list from get_interface_list().
  35  * @param do_hide Hide the "hidden" interfaces.
  36  *
  37  * @return A list of if_info_t structs.
  38  */
  39 GList *build_capture_combo_list(GList *if_list, gboolean do_hide);
  40
  41 /** Free the GList from build_capture_combo_list().
  42  *
  43  * @param combo_list the interface list from build_capture_combo_list()
  44  */
  45 void free_capture_combo_list(GList *combo_list);
  46
  47
  48 /** Given text that contains an interface name possibly prefixed by an
  49  * interface description, extract the interface name.
  50  *
  51  * @param if_text A string containing the interface description + name.
  52  * This is usually the data from one of the list elements returned by
  53  * build_capture_combo_list().
  54  *
  55  * @return The raw interface name, sans description.
  56  */
  57 char *get_if_name(char *if_text);
  58
  59 #endif