epan/report_err.h

   1 /* report_err.h
   2  * Declarations of routines for code that can run in GUI and command-line
   3  * environments to use to report errors to the user (e.g., I/O errors, or
   4  * problems with preference settings).
   5  *
   6  * The application using libwireshark will register error-reporting
   7  * routines, and the routines declared here will call the registered
   8  * routines.  That way, these routines can be called by code that
   9  * doesn't itself know whether to pop up a dialog or print something
  10  * to the standard error.
  11  *
  12  * $Id$
  13  *
  14  * Wireshark - Network traffic analyzer
  15  * By Gerald Combs <gerald@wireshark.org>
  16  * Copyright 1998 Gerald Combs
  17  *
  18  * This program is free software; you can redistribute it and/or
  19  * modify it under the terms of the GNU General Public License
  20  * as published by the Free Software Foundation; either version 2
  21  * of the License, or (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program; if not, write to the Free Software
  30  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  31  */
  32
  33 #ifndef __REPORT_ERR_H__
  34 #define __REPORT_ERR_H__
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif /* __cplusplus */
  39
  40 /*
  41  *  Initialize the report err routines
  42  */
  43 extern void init_report_err(
  44         void (*report_failure)(const char *, va_list),
  45         void (*report_open_failure)(const char *, int, gboolean),
  46         void (*report_read_failure)(const char *, int),
  47         void (*report_write_failure)(const char *, int));
  48
  49 /*
  50  * Report a general error.
  51  */
  52 extern void report_failure(const char *msg_format, ...);
  53
  54 /*
  55  * Report an error when trying to open a file.
  56  * "err" is assumed to be an error code from Wiretap; positive values are
  57  * UNIX-style errnos, so this can be used for open failures not from
  58  * Wiretap as long as the failure code is just an errno.
  59  */
  60 extern void report_open_failure(const char *filename, int err,
  61     gboolean for_writing);
  62
  63 /*
  64  * Report an error when trying to read a file.
  65  * "err" is assumed to be a UNIX-style errno.
  66  */
  67 extern void report_read_failure(const char *filename, int err);
  68
  69 /*
  70  * Report an error when trying to write a file.
  71  * "err" is assumed to be a UNIX-style errno.
  72  */
  73 extern void report_write_failure(const char *filename, int err);
  74
  75 #ifdef __cplusplus
  76 }
  77 #endif /* __cplusplus */
  78
  79 #endif /* __REPORT_ERR_H__ */