file_dialog.h File Reference

Go to the source code of this file.

Classes
struct	ws_file_preview_stats
	Summary statistics gathered during a capture file preview scan. More...

Enumerations
enum	check_savability_t { SAVE , SAVE_WITHOUT_COMMENTS , SAVE_IN_ANOTHER_FORMAT , CANCELLED }
	Outcome of a "check if savable" prompt when closing or overwriting a capture file. More...
enum	export_type_e {   export_type_text = 1 , export_type_ps , export_type_csv , export_type_psml ,   export_type_pdml , export_type_carrays , export_type_json }
	Output format for packet data export operations. More...
enum	ws_file_preview_stats_status { PREVIEW_SUCCEEDED , PREVIEW_TIMED_OUT , PREVIEW_READ_ERROR }
	Return status for a capture file preview statistics scan. More...

Functions
ws_file_preview_stats_status	get_stats_for_preview (wtap *wth, ws_file_preview_stats *stats, int *err, char **err_info)
	Retrieves statistics for file preview.

Detailed Description

Common file dialog definitions

Wireshark - Network traffic analyzer By Gerald Combs geral.nosp@m.d@wi.nosp@m.resha.nosp@m.rk.o.nosp@m.rg Copyright 2006 Gerald Combs

SPDX-License-Identifier: GPL-2.0-or-later

Enumeration Type Documentation

check_savability_t

enum check_savability_t

Outcome of a "check if savable" prompt when closing or overwriting a capture file.

Enumerator
SAVE	User chose to save the file in its current format
SAVE_WITHOUT_COMMENTS	User chose to save the file but discard packet comments
SAVE_IN_ANOTHER_FORMAT	User chose to save the file in a different format
CANCELLED	User cancelled the save/close operation

export_type_e

enum export_type_e

Output format for packet data export operations.

Enumerator
export_type_text	Plain text export
export_type_ps	PostScript export
export_type_csv	Comma-separated values (CSV) export
export_type_psml	Packet Summary Markup Language (PSML) XML export
export_type_pdml	Packet Details Markup Language (PDML) XML export
export_type_carrays	C array source code export
export_type_json	JSON export

ws_file_preview_stats_status

enum ws_file_preview_stats_status

Return status for a capture file preview statistics scan.

Enumerator
PREVIEW_SUCCEEDED	Preview scan completed successfully
PREVIEW_TIMED_OUT	Preview scan was aborted because it exceeded the time limit
PREVIEW_READ_ERROR	Preview scan failed due to a file read error

Function Documentation

get_stats_for_preview()

ws_file_preview_stats_status get_stats_for_preview ( wtap *  wth, ws_file_preview_stats *  stats, int *  err, char **  err_info  )

extern

Retrieves statistics for file preview.

Parameters

wth	Pointer to the wtap structure representing the capture file.
stats	Pointer to the ws_file_preview_stats structure where the statistics will be stored.
err	Pointer to an integer that will hold any error code if an error occurs.
err_info	Pointer to a char pointer that will hold any error information if an error occurs.