Wireshark 4.5.0
The Wireshark network protocol analyzer
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions
/builds/wireshark/wireshark/file.h File Reference
#include <wiretap/wtap.h>
#include <epan/epan.h>
#include <epan/print.h>
#include <epan/fifo_string_cache.h>
#include <ui/packet_range.h>

Go to the source code of this file.

Classes

struct  match_data
 
struct  print_args_t
 

Typedefs

typedef void(* cf_callback_t) (int event, void *data, void *user_data)
 

Enumerations

enum  cf_status_t { CF_OK , CF_ERROR }
 
enum  cf_read_status_t { CF_READ_OK , CF_READ_ERROR , CF_READ_ABORTED }
 
enum  cf_write_status_t { CF_WRITE_OK , CF_WRITE_ERROR , CF_WRITE_ABORTED }
 
enum  cf_print_status_t { CF_PRINT_OK , CF_PRINT_OPEN_ERROR , CF_PRINT_WRITE_ERROR }
 
enum  cf_cbs {
  cf_cb_file_opened , cf_cb_file_closing , cf_cb_file_closed , cf_cb_file_read_started ,
  cf_cb_file_read_finished , cf_cb_file_reload_started , cf_cb_file_reload_finished , cf_cb_file_rescan_started ,
  cf_cb_file_rescan_finished , cf_cb_file_retap_started , cf_cb_file_retap_finished , cf_cb_file_merge_started ,
  cf_cb_file_merge_finished , cf_cb_file_fast_save_finished , cf_cb_file_save_started , cf_cb_file_save_finished ,
  cf_cb_file_save_failed , cf_cb_file_save_stopped
}
 
enum  print_range_e { print_range_selected_only , print_range_marked_only , print_range_all_displayed , print_range_all_captured }
 

Functions

void cf_set_max_records (unsigned max_records)
 
void cf_callback_add (cf_callback_t func, void *user_data)
 
void cf_callback_remove (cf_callback_t func, void *user_data)
 
cf_status_t cf_open (capture_file *cf, const char *fname, unsigned int type, bool is_tempfile, int *err)
 
void cf_close (capture_file *cf)
 
cf_status_t cf_reload (capture_file *cf)
 
cf_read_status_t cf_read (capture_file *cf, bool reloading)
 
bool cf_read_record (capture_file *cf, const frame_data *fdata, wtap_rec *rec, Buffer *buf)
 
bool cf_read_record_no_alert (capture_file *cf, const frame_data *fdata, wtap_rec *rec, Buffer *buf)
 
bool cf_read_current_record (capture_file *cf)
 
cf_read_status_t cf_continue_tail (capture_file *cf, volatile int to_read, wtap_rec *rec, Buffer *buf, int *err, fifo_string_cache_t *frame_dup_cache, GChecksum *frame_cksum)
 
void cf_fake_continue_tail (capture_file *cf)
 
cf_read_status_t cf_finish_tail (capture_file *cf, wtap_rec *rec, Buffer *buf, int *err, fifo_string_cache_t *frame_dup_cache, GChecksum *frame_cksum)
 
bool cf_can_write_with_wiretap (capture_file *cf)
 
bool cf_can_save (capture_file *cf)
 
bool cf_can_save_as (capture_file *cf)
 
bool cf_has_unsaved_data (capture_file *cf)
 
cf_write_status_t cf_save_records (capture_file *cf, const char *fname, unsigned save_format, wtap_compression_type compression_type, bool discard_comments, bool dont_reopen)
 
cf_write_status_t cf_export_specified_packets (capture_file *cf, const char *fname, packet_range_t *range, unsigned save_format, wtap_compression_type compression_type)
 
char * cf_get_display_name (capture_file *cf)
 
char * cf_get_basename (capture_file *cf)
 
void cf_set_tempfile_source (capture_file *cf, char *source)
 
const char * cf_get_tempfile_source (capture_file *cf)
 
int cf_get_packet_count (capture_file *cf)
 
bool cf_is_tempfile (capture_file *cf)
 
void cf_set_tempfile (capture_file *cf, bool is_tempfile)
 
void cf_set_drops_known (capture_file *cf, bool drops_known)
 
void cf_set_drops (capture_file *cf, uint32_t drops)
 
bool cf_get_drops_known (capture_file *cf)
 
uint32_t cf_get_drops (capture_file *cf)
 
void cf_set_rfcode (capture_file *cf, dfilter_t *rfcode)
 
cf_status_t cf_filter_packets (capture_file *cf, char *dfilter, bool force)
 
void cf_reftime_packets (capture_file *cf)
 
unsigned long cf_get_computed_elapsed (capture_file *cf)
 
void cf_redissect_packets (capture_file *cf)
 
cf_read_status_t cf_retap_packets (capture_file *cf)
 
cf_print_status_t cf_print_packets (capture_file *cf, print_args_t *print_args, bool show_progress_bar)
 
cf_print_status_t cf_write_pdml_packets (capture_file *cf, print_args_t *print_args)
 
cf_print_status_t cf_write_psml_packets (capture_file *cf, print_args_t *print_args)
 
cf_print_status_t cf_write_csv_packets (capture_file *cf, print_args_t *print_args)
 
cf_print_status_t cf_write_carrays_packets (capture_file *cf, print_args_t *print_args)
 
cf_print_status_t cf_write_json_packets (capture_file *cf, print_args_t *print_args)
 
bool cf_find_packet_protocol_tree (capture_file *cf, const char *string, search_direction dir, bool multiple)
 
field_infocf_find_string_protocol_tree (capture_file *cf, proto_tree *tree)
 
bool cf_find_packet_summary_line (capture_file *cf, const char *string, search_direction dir)
 
bool cf_find_packet_data (capture_file *cf, const uint8_t *string, size_t string_size, search_direction dir, bool multiple)
 
bool cf_find_packet_dfilter (capture_file *cf, dfilter_t *sfcode, search_direction dir, bool start_current)
 
bool cf_find_packet_dfilter_string (capture_file *cf, const char *filter, search_direction dir)
 
bool cf_find_packet_marked (capture_file *cf, search_direction dir)
 
bool cf_find_packet_time_reference (capture_file *cf, search_direction dir)
 
bool cf_goto_frame (capture_file *cf, unsigned row, bool exact)
 
bool cf_goto_framenum (capture_file *cf)
 
void cf_select_packet (capture_file *cf, frame_data *frame)
 
void cf_unselect_packet (capture_file *cf)
 
void cf_mark_frame (capture_file *cf, frame_data *frame)
 
void cf_unmark_frame (capture_file *cf, frame_data *frame)
 
void cf_ignore_frame (capture_file *cf, frame_data *frame)
 
void cf_unignore_frame (capture_file *cf, frame_data *frame)
 
cf_status_t cf_merge_files_to_tempfile (void *pd_window, const char *temp_dir, char **out_filenamep, int in_file_count, const char *const *in_filenames, int file_type, bool do_append)
 
void cf_update_section_comment (capture_file *cf, char *comment)
 
void cf_update_section_comments (capture_file *cf, unsigned shb_idx, char **comments)
 
wtap_block_t cf_get_packet_block (capture_file *cf, const frame_data *fd)
 
bool cf_set_modified_block (capture_file *cf, frame_data *fd, const wtap_block_t new_block)
 
uint32_t cf_comment_types (capture_file *cf)
 
bool cf_add_ip_name_from_string (capture_file *cf, const char *addr, const char *name)
 

Detailed Description

Definitions for file structures and routines

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

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

Enumeration Type Documentation

◆ cf_print_status_t

Return values from functions that print sets of packets.

Enumerator
CF_PRINT_OK 

print operation succeeded

CF_PRINT_OPEN_ERROR 

print operation failed while opening printer

CF_PRINT_WRITE_ERROR 

print operation failed while writing to the printer

◆ cf_read_status_t

Return values from functions that read capture files.

Enumerator
CF_READ_OK 

operation succeeded

CF_READ_ERROR 

operation got an error (function may provide err with details)

CF_READ_ABORTED 

operation aborted by user

◆ cf_status_t

Return values from functions that only can succeed or fail.

Enumerator
CF_OK 

operation succeeded

CF_ERROR 

operation got an error (function may provide err with details)

◆ cf_write_status_t

Return values from functions that write out packets.

Enumerator
CF_WRITE_OK 

operation succeeded

CF_WRITE_ERROR 

operation got an error (function may provide err with details)

CF_WRITE_ABORTED 

operation aborted by user

Function Documentation

◆ cf_add_ip_name_from_string()

bool cf_add_ip_name_from_string ( capture_file cf,
const char *  addr,
const char *  name 
)

Add a resolved address to this file's list of resolved addresses.

Parameters
cfthe capture file
addra string representing an IPv4 or IPv6 address
namea string containing a name corresponding to that address
Returns
true if it succeeds, false if not

◆ cf_callback_add()

void cf_callback_add ( cf_callback_t  func,
void *  user_data 
)
extern

Add a capture file event callback.

Parameters
funcThe function to be called for each event. The function will be passed three parameters: The event type (event), event-dependent data (data), and user-supplied data (user_data). Event-dependent data may be a capture_file pointer, character pointer, or NULL.
user_dataUser-supplied data to pass to the callback. May be NULL.

◆ cf_callback_remove()

void cf_callback_remove ( cf_callback_t  func,
void *  user_data 
)
extern

Remove a capture file event callback.

Parameters
funcThe function to be removed.
user_dataUser-supplied data. Must be the same value supplied to cf_callback_add.

◆ cf_can_save()

bool cf_can_save ( capture_file cf)

Determine whether this capture file can be saved with a "save" operation; if there's nothing unsaved, it can't.

Parameters
cfthe capture file to check
Returns
true if it can be saved, false if it can't

◆ cf_can_save_as()

bool cf_can_save_as ( capture_file cf)

Determine whether this capture file can be saved with a "save as" operation.

Parameters
cfthe capture file to check
Returns
true if it can be saved, false if it can't

◆ cf_can_write_with_wiretap()

bool cf_can_write_with_wiretap ( capture_file cf)

Determine whether this capture file (or a range of it) can be written in any format using Wiretap rather than by copying the raw data.

Parameters
cfthe capture file to check
Returns
true if it can be written, false if it can't

◆ cf_close()

void cf_close ( capture_file cf)

Close a capture file.

Parameters
cfthe capture file to be closed

◆ cf_comment_types()

uint32_t cf_comment_types ( capture_file cf)

What types of comments does this file have?

Parameters
cfthe capture file
Returns
bitset of WTAP_COMMENT_ values

◆ cf_continue_tail()

cf_read_status_t cf_continue_tail ( capture_file cf,
volatile int  to_read,
wtap_rec rec,
Buffer buf,
int *  err,
fifo_string_cache_t frame_dup_cache,
GChecksum *  frame_cksum 
)

Read packets from the "end" of a capture file.

Parameters
cfthe capture file to be read from
to_readthe number of packets to read
recpointer to wtap_rec to use when reading
bufpointer to Buffer to use when reading
errthe error code, if an error had occurred
Returns
one of cf_read_status_t

◆ cf_export_specified_packets()

cf_write_status_t cf_export_specified_packets ( capture_file cf,
const char *  fname,
packet_range_t range,
unsigned  save_format,
wtap_compression_type  compression_type 
)

Export some or all packets from a capture file to a new file. If there's already a file with that name, do a "safe save", writing to a temporary file in the same directory and, if the write succeeds, renaming the new file on top of the old file, so that if the write fails, the old file is still intact.

Parameters
cfthe capture file to write to
fnamethe filename to write to
rangethe range of packets to write
save_formatthe format of the file to write (libpcap, ...)
compression_typetype of compression to use when writing, if any
Returns
one of cf_write_status_t

◆ cf_fake_continue_tail()

void cf_fake_continue_tail ( capture_file cf)

Fake reading packets from the "end" of a capture file.

Parameters
cfthe capture file to be read from

◆ cf_filter_packets()

cf_status_t cf_filter_packets ( capture_file cf,
char *  dfilter,
bool  force 
)

"Display Filter" packets in the capture file.

Parameters
cfthe capture file
dfilterthe display filter
forcetrue if do in any case, false only if dfilter changed
Returns
one of cf_status_t

◆ cf_find_packet_data()

bool cf_find_packet_data ( capture_file cf,
const uint8_t *  string,
size_t  string_size,
search_direction  dir,
bool  multiple 
)

Find packet whose data contains a specified byte string.

Parameters
cfthe capture file
stringthe string to find
string_sizethe size of the string to find
dirdirection in which to search
multiplewhether to look for the next occurrence of the same string in the current packet, or to only match once per frame
Returns
true if a packet was found, false otherwise

◆ cf_find_packet_dfilter()

bool cf_find_packet_dfilter ( capture_file cf,
dfilter_t sfcode,
search_direction  dir,
bool  start_current 
)

Find packet that matches a compiled display filter.

Parameters
cfthe capture file
sfcodethe display filter to match
dirdirection in which to search
start_currentwhether to start searching from the current frame
Returns
true if a packet was found, false otherwise

◆ cf_find_packet_dfilter_string()

bool cf_find_packet_dfilter_string ( capture_file cf,
const char *  filter,
search_direction  dir 
)

Find packet that matches a display filter given as a text string.

Parameters
cfthe capture file
filterthe display filter to match
dirdirection in which to search
Returns
true if a packet was found, false otherwise

◆ cf_find_packet_marked()

bool cf_find_packet_marked ( capture_file cf,
search_direction  dir 
)

Find marked packet.

Parameters
cfthe capture file
dirdirection in which to search
Returns
true if a packet was found, false otherwise

◆ cf_find_packet_protocol_tree()

bool cf_find_packet_protocol_tree ( capture_file cf,
const char *  string,
search_direction  dir,
bool  multiple 
)

Find packet with a protocol tree item that contains a specified text string.

Parameters
cfthe capture file
stringthe string to find
dirdirection in which to search
multiplewhether to look for the next occurrence of the same string in the current packet, or to only match once per frame
Returns
true if a packet was found, false otherwise

◆ cf_find_packet_summary_line()

bool cf_find_packet_summary_line ( capture_file cf,
const char *  string,
search_direction  dir 
)

Find packet whose summary line contains a specified text string.

Parameters
cfthe capture file
stringthe string to find
dirdirection in which to search
Returns
true if a packet was found, false otherwise

◆ cf_find_packet_time_reference()

bool cf_find_packet_time_reference ( capture_file cf,
search_direction  dir 
)

Find time-reference packet.

Parameters
cfthe capture file
dirdirection in which to search
Returns
true if a packet was found, false otherwise

◆ cf_find_string_protocol_tree()

field_info * cf_find_string_protocol_tree ( capture_file cf,
proto_tree tree 
)
extern

Find field with a label that contains the text string cfile->sfilter in a protocol tree.

Parameters
cfthe capture file
treethe protocol tree
Returns
The first field in the tree that matched the string if found, NULL otherwise

◆ cf_finish_tail()

cf_read_status_t cf_finish_tail ( capture_file cf,
wtap_rec rec,
Buffer buf,
int *  err,
fifo_string_cache_t frame_dup_cache,
GChecksum *  frame_cksum 
)

Finish reading from "end" of a capture file.

Parameters
cfthe capture file to be read from
recpointer to wtap_rec to use when reading
bufpointer to Buffer to use when reading
errthe error code, if an error had occurred
Returns
one of cf_read_status_t

◆ cf_get_basename()

char * cf_get_basename ( capture_file cf)

Get a name that can be used to generate a file name from the capture file name. It's based on the displayable name, so it's UTF-8; if it ends with a suffix that's used by a file type libwiretap can read, we strip that suffix off.

Parameters
cfthe capture file
Returns
the base name (must be g_free'd)

◆ cf_get_computed_elapsed()

unsigned long cf_get_computed_elapsed ( capture_file cf)

Return the time it took to load the file (in msec).

◆ cf_get_display_name()

char * cf_get_display_name ( capture_file cf)

Get a displayable name of the capture file.

Parameters
cfthe capture file
Returns
the displayable name (must be g_free'd)

◆ cf_get_drops()

uint32_t cf_get_drops ( capture_file cf)

Get the number of packet drops while capturing.

Parameters
cfthe capture file
Returns
the number of packet drops occurred while capturing

◆ cf_get_drops_known()

bool cf_get_drops_known ( capture_file cf)

Get flag state, if the number of packet drops while capturing are known or not.

Parameters
cfthe capture file
Returns
true if the number of packet drops are known, false otherwise

◆ cf_get_packet_count()

int cf_get_packet_count ( capture_file cf)

Get the number of packets in the capture file.

Parameters
cfthe capture file
Returns
the number of packets in the capture file

◆ cf_get_tempfile_source()

const char * cf_get_tempfile_source ( capture_file cf)

Get the source of the capture data for temporary files. Guaranteed to return a non-null value. The returned value should not be freed.

Parameters
cfthe capture file

◆ cf_goto_frame()

bool cf_goto_frame ( capture_file cf,
unsigned  row,
bool  exact 
)

GoTo Packet with the given row.

Parameters
cfthe capture file
rowthe row to go to
exactif true, fail if the row exists and is filtered (not displayed) if false, go to the nearest displayed packet instead
Returns
true if this row exists, false otherwise

◆ cf_goto_framenum()

bool cf_goto_framenum ( capture_file cf)

Go to frame specified by currently selected protocol tree field. (Go To Corresponding Packet)

Todo:
this is ugly and should be improved!
Parameters
cfthe capture file
Returns
true if this packet exists, false otherwise

◆ cf_has_unsaved_data()

bool cf_has_unsaved_data ( capture_file cf)

Determine whether this capture file has unsaved data.

Parameters
cfthe capture file to check
Returns
true if it has unsaved data, false if it doesn't

◆ cf_ignore_frame()

void cf_ignore_frame ( capture_file cf,
frame_data *  frame 
)

Ignore a particular frame in a particular capture.

Parameters
cfthe capture file
framethe frame to be ignored

◆ cf_is_tempfile()

bool cf_is_tempfile ( capture_file cf)

Is this capture file a temporary file?

Parameters
cfthe capture file
Returns
true if it's a temporary file, false otherwise

◆ cf_mark_frame()

void cf_mark_frame ( capture_file cf,
frame_data *  frame 
)

Mark a particular frame in a particular capture.

Parameters
cfthe capture file
framethe frame to be marked

◆ cf_merge_files_to_tempfile()

cf_status_t cf_merge_files_to_tempfile ( void *  pd_window,
const char *  temp_dir,
char **  out_filenamep,
int  in_file_count,
const char *const *  in_filenames,
int  file_type,
bool  do_append 
)

Merge two or more capture files into a temporary file.

Todo:
is this the right place for this function? It doesn't have to do a lot with capture_file.
Parameters
pd_windowWindow pointer suitable for use by delayed_create_progress_dlg.
out_filenamepPoints to a pointer that's set to point to the pathname of the temporary file; it's allocated with g_malloc()
in_file_countthe number of input files to merge
in_filenamesarray of input filenames
file_typethe output filetype
do_appendfalse to merge chronologically, true simply append
Returns
one of cf_status_t

◆ cf_open()

cf_status_t cf_open ( capture_file cf,
const char *  fname,
unsigned int  type,
bool  is_tempfile,
int *  err 
)

Open a capture file.

Parameters
cfthe capture file to be opened
fnamethe filename to be opened
typeWTAP_TYPE_AUTO for automatic or index to direct open routine
is_tempfileis this a temporary file?
errerror code
Returns
one of cf_status_t

◆ cf_print_packets()

cf_print_status_t cf_print_packets ( capture_file cf,
print_args_t print_args,
bool  show_progress_bar 
)

Print the capture file.

Parameters
cfthe capture file
print_argsthe arguments what and how to print
show_progress_bartrue if a progress bar is to be shown
Returns
one of cf_print_status_t

◆ cf_read()

cf_read_status_t cf_read ( capture_file cf,
bool  reloading 
)

Read all packets of a capture file into the internal structures.

Parameters
cfthe capture file to be read
reloadingreread asked for from cf_save_records()
Returns
one of cf_read_status_t

◆ cf_read_current_record()

bool cf_read_current_record ( capture_file cf)

Read the metadata and raw data for the current record into a capture_file structure's rec and buf for the current record. It will pop up an alert box if there's an error.

Parameters
cfthe capture file from which to read the record
Returns
true if the read succeeded, false if there was an error

◆ cf_read_record()

bool cf_read_record ( capture_file cf,
const frame_data *  fdata,
wtap_rec rec,
Buffer buf 
)

Read the metadata and raw data for a record. It will pop up an alert box if there's an error.

Parameters
cfthe capture file from which to read the record
fdatathe frame_data structure for the record in question
recpointer to a wtap_rec structure to contain the record's metadata
bufa Buffer into which to read the record's raw data
Returns
true if the read succeeded, false if there was an error

◆ cf_read_record_no_alert()

bool cf_read_record_no_alert ( capture_file cf,
const frame_data *  fdata,
wtap_rec rec,
Buffer buf 
)

Same as cf_read_record() but does not pop alert box on error

◆ cf_redissect_packets()

void cf_redissect_packets ( capture_file cf)

"Something" has changed, rescan all packets.

Parameters
cfthe capture file

◆ cf_reftime_packets()

void cf_reftime_packets ( capture_file cf)

Scan through all frame data and recalculate the ref time without rereading the file.

Parameters
cfthe capture file

◆ cf_reload()

cf_status_t cf_reload ( capture_file cf)

Reload a capture file.

Parameters
cfthe capture file to be reloaded
Returns
one of cf_status_t

◆ cf_retap_packets()

cf_read_status_t cf_retap_packets ( capture_file cf)

Rescan all packets and just run taps - don't reconstruct the display.

Parameters
cfthe capture file
Returns
one of cf_read_status_t

◆ cf_save_records()

cf_write_status_t cf_save_records ( capture_file cf,
const char *  fname,
unsigned  save_format,
wtap_compression_type  compression_type,
bool  discard_comments,
bool  dont_reopen 
)

Save all packets in a capture file to a new file, and, if that succeeds, make that file the current capture file. If there's already a file with that name, do a "safe save", writing to a temporary file in the same directory and, if the write succeeds, renaming the new file on top of the old file, so that if the write fails, the old file is still intact.

Parameters
cfthe capture file to save to
fnamethe filename to save to
save_formatthe format of the file to save (libpcap, ...)
compression_typetype of compression to use when writing, if any
discard_commentstrue if we should discard comments if the save succeeds (because we saved in a format that doesn't support comments)
dont_reopentrue if it shouldn't reopen and make that file the current capture file
Returns
one of cf_write_status_t

◆ cf_select_packet()

void cf_select_packet ( capture_file cf,
frame_data *  frame 
)

Select the packet in the given row.

Parameters
cfthe capture file
framethe frame to be selected

◆ cf_set_drops()

void cf_set_drops ( capture_file cf,
uint32_t  drops 
)

Set the number of packet drops while capturing.

Parameters
cfthe capture file
dropsthe number of packet drops occurred while capturing

◆ cf_set_drops_known()

void cf_set_drops_known ( capture_file cf,
bool  drops_known 
)

Set flag, if the number of packet drops while capturing are known or not.

Parameters
cfthe capture file
drops_knowntrue if the number of packet drops are known, false otherwise

◆ cf_set_max_records()

void cf_set_max_records ( unsigned  max_records)
extern

Set maximum number of records per capture file.

Parameters
max_recordsmaximum number of records to support.

◆ cf_set_modified_block()

bool cf_set_modified_block ( capture_file cf,
frame_data *  fd,
const wtap_block_t  new_block 
)

Update(replace) the block on a capture from a frame

Parameters
cfthe capture file
fdthe frame_data structure for the frame
new_blockthe block replacing the old block
Returns
true if the block is modified for the first time. false if the block was already modified before, in which case the caller is responsible for updating the comment count.

◆ cf_set_rfcode()

void cf_set_rfcode ( capture_file cf,
dfilter_t rfcode 
)

Set the read filter.

Todo:
this shouldn't be required, remove it somehow
Parameters
cfthe capture file
rfcodethe readfilter

◆ cf_set_tempfile()

void cf_set_tempfile ( capture_file cf,
bool  is_tempfile 
)

Set flag, that this file is a tempfile.

◆ cf_set_tempfile_source()

void cf_set_tempfile_source ( capture_file cf,
char *  source 
)

Set the source of the capture data for temporary files, e.g. "Interface eth0" or "Pipe from Pong"

Parameters
cfthe capture file
sourcethe source description. this will be copied internally.

◆ cf_unignore_frame()

void cf_unignore_frame ( capture_file cf,
frame_data *  frame 
)

Unignore a particular frame in a particular capture.

Parameters
cfthe capture file
framethe frame to be unignored

◆ cf_unmark_frame()

void cf_unmark_frame ( capture_file cf,
frame_data *  frame 
)

Unmark a particular frame in a particular capture.

Parameters
cfthe capture file
framethe frame to be unmarked

◆ cf_unselect_packet()

void cf_unselect_packet ( capture_file cf)

Unselect all packets, if any.

Parameters
cfthe capture file

◆ cf_update_section_comment()

void cf_update_section_comment ( capture_file cf,
char *  comment 
)

Update(replace) the comment on a capture from the SHB data block XXX - should support multiple sections.

Parameters
cfthe capture file
commentthe string replacing the old comment

◆ cf_update_section_comments()

void cf_update_section_comments ( capture_file cf,
unsigned  shb_idx,
char **  comments 
)

Update(replace) the comments on a capture from the SHB data block

Parameters
cfthe capture file
shb_idxthe index of the SHB (0-indexed)
commentsa NULL-terminated string array of comments. The function takes ownership of the string array and frees it and the contents.

◆ cf_write_carrays_packets()

cf_print_status_t cf_write_carrays_packets ( capture_file cf,
print_args_t print_args 
)

Print (export) the capture file into C Arrays format.

Parameters
cfthe capture file
print_argsthe arguments what and how to export
Returns
one of cf_print_status_t

◆ cf_write_csv_packets()

cf_print_status_t cf_write_csv_packets ( capture_file cf,
print_args_t print_args 
)

Print (export) the capture file into CSV format.

Parameters
cfthe capture file
print_argsthe arguments what and how to export
Returns
one of cf_print_status_t

◆ cf_write_json_packets()

cf_print_status_t cf_write_json_packets ( capture_file cf,
print_args_t print_args 
)

Print (export) the capture file into JSON format.

Parameters
cfthe capture file
print_argsthe arguments what and how to export
Returns
one of cf_print_status_t

◆ cf_write_pdml_packets()

cf_print_status_t cf_write_pdml_packets ( capture_file cf,
print_args_t print_args 
)

Print (export) the capture file into PDML format.

Parameters
cfthe capture file
print_argsthe arguments what and how to export
Returns
one of cf_print_status_t

◆ cf_write_psml_packets()

cf_print_status_t cf_write_psml_packets ( capture_file cf,
print_args_t print_args 
)

Print (export) the capture file into PSML format.

Parameters
cfthe capture file
print_argsthe arguments what and how to export
Returns
one of cf_print_status_t