file_type_subtype_info Struct Reference

Describes a single capture file type/subtype, including its metadata, capability flags, and I/O function pointers. More...

#include <wtap.h>

Public Attributes
const char *	description
const char *	name
const char *	default_file_extension
const char *	additional_file_extensions
bool	writing_must_seek
size_t	num_supported_blocks
const struct supported_block_type *	supported_blocks
int(*	can_write_encap )(int)
bool(*	dump_open )(wtap_dumper *, int *, char **)
wtap_wslua_file_info_t *	wslua_info

Detailed Description

Describes a single capture file type/subtype, including its metadata, capability flags, and I/O function pointers.

Member Data Documentation

additional_file_extensions

const char* file_type_subtype_info::additional_file_extensions

A semicolon-separated list of additional file extensions used for this type. Should be NULL if no extensions, or no extensions other than the default extension, are known.

can_write_encap

int(* file_type_subtype_info::can_write_encap) (int)

Can this type write this encapsulation format? Should be NULL is this file type doesn't have write support.

XXX - This returns an int because it can return err codes, specifically WTAP_ERR_CHECK_WSLUA (instead of having an int *err parameter like the other functions.)

default_file_extension

const char* file_type_subtype_info::default_file_extension

The default file extension, used to save this type. Should be NULL if no default extension is known.

description

const char* file_type_subtype_info::description

The file type description.

dump_open

bool(* file_type_subtype_info::dump_open) (wtap_dumper *, int *, char **)

The function to open the capture file for writing. Should be NULL if this file type doesn't have write support.

name

const char* file_type_subtype_info::name

The file type name, used to look up file types by name, e.g. looking up a file type specified as a command-line argument.

num_supported_blocks

size_t file_type_subtype_info::num_supported_blocks

Number of block types supported.

supported_blocks

const struct supported_block_type* file_type_subtype_info::supported_blocks

Table of block types supported.

writing_must_seek

bool file_type_subtype_info::writing_must_seek

When writing this file format, is seeking required?

wslua_info

wtap_wslua_file_info_t* file_type_subtype_info::wslua_info

If can_write_encap returned WTAP_ERR_CHECK_WSLUA, then this is used instead. This should be NULL for everyone except Lua-based file writers.

---

The documentation for this struct was generated from the following file:

• /builds/wireshark/wireshark/wiretap/wtap.h