| Wireshark 4.7.0 The Wireshark network protocol analyzer

Loading...
Searching...
No Matches
report_message.h
Go to the documentation of this file.
1
22#ifndef __REPORT_MESSAGE_H__
23#define __REPORT_MESSAGE_H__
24
25#include <wireshark.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif /* __cplusplus */
30
31/*
32 * Initialize the report message routines
33 */
34 struct report_message_routines {
35 void (*vreport_failure)(const char *, va_list);
36 void (*vreport_warning)(const char *, va_list);
37 void (*report_open_failure)(const char *, int, bool);
38 void (*report_read_failure)(const char *, int);
39 void (*report_write_failure)(const char *, int);
40 void (*report_rename_failure)(const char *, const char *, int);
41 void (*report_cfile_open_failure)(const char *, int, char *);
42 void (*report_cfile_dump_open_failure)(const char *, int, char *, int);
43 void (*report_cfile_read_failure)(const char *, int, char *);
44 void (*report_cfile_write_failure)(const char *, const char *,
45 int, char *, uint64_t, int);
46 void (*report_cfile_close_failure)(const char *, int, char *);
47};
48
64WS_DLL_PUBLIC void init_report_message(const char *friendly_program_name,
65 const struct report_message_routines *routines);
66
75WS_DLL_PUBLIC void report_failure(const char *msg_format, ...) G_GNUC_PRINTF(1, 2);
76
85WS_DLL_PUBLIC void report_warning(const char *msg_format, ...) G_GNUC_PRINTF(1, 2);
86
87
88/*
89 * Report an error when trying to open a file.
90 * "err" is assumed to be an error code from Wiretap; positive values are
91 * UNIX-style errnos, so this can be used for open failures not from
92 * Wiretap as long as the failure code is just an errno.
93 */
94WS_DLL_PUBLIC void report_open_failure(const char *filename, int err,
95 bool for_writing);
96
97/*
98 * Report an error when trying to read a file.
99 * "err" is assumed to be a UNIX-style errno.
100 */
101WS_DLL_PUBLIC void report_read_failure(const char *filename, int err);
102
103/*
104 * Report an error when trying to write a file.
105 * "err" is assumed to be a UNIX-style errno.
106 */
107WS_DLL_PUBLIC void report_write_failure(const char *filename, int err);
108
109/*
110 * Report an error when trying to rename a file.
111 * "err" is assumed to be a UNIX-style errno.
112 */
113WS_DLL_PUBLIC void report_rename_failure(const char *old_filename,
114 const char *new_filename, int err);
115
116/*
117 * Report an error from opening a capture file for reading.
118 */
119WS_DLL_PUBLIC void report_cfile_open_failure(const char *filename,
120 int err, char *err_info);
121
122/*
123 * Report an error from opening a capture file for writing.
124 */
125WS_DLL_PUBLIC void report_cfile_dump_open_failure(const char *filename,
126 int err, char *err_info, int file_type_subtype);
127
128/*
129 * Report an error from attempting to read from a capture file.
130 */
131WS_DLL_PUBLIC void report_cfile_read_failure(const char *filename,
132 int err, char *err_info);
133
134/*
135 * Report an error from attempting to write to a capture file.
136 */
137WS_DLL_PUBLIC void report_cfile_write_failure(const char *in_filename,
138 const char *out_filename, int err, char *err_info, uint64_t framenum,
139 int file_type_subtype);
140
141/*
142 * Report an error from closing a capture file open for writing.
143 */
144WS_DLL_PUBLIC void report_cfile_close_failure(const char *filename,
145 int err, char *err_info);
146
150WS_DLL_PUBLIC const char *get_friendly_program_name(void);
151
152#ifdef __cplusplus
153}
154#endif /* __cplusplus */
155
156#endif /* __REPORT_MESSAGE_H__ */
get_friendly_program_name
WS_DLL_PUBLIC const char * get_friendly_program_name(void)
Return the "friendly" program name.
Definition report_message.c:157
report_warning
WS_DLL_PUBLIC void WS_DLL_PUBLIC void report_warning(const char *msg_format,...) G_GNUC_PRINTF(1
Report a general warning message.
report_failure
WS_DLL_PUBLIC void report_failure(const char *msg_format,...) G_GNUC_PRINTF(1
Report a general error message.
init_report_message
WS_DLL_PUBLIC void init_report_message(const char *friendly_program_name, const struct report_message_routines *routines)
Initialize the report message system with program context and output routines.
Definition report_message.c:27
report_message_routines
Definition report_message.h:34