print_stream_ops Struct Reference

Vtable of operations implementing a print stream backend for rendering dissection output. More...

#include <print_stream.h>

Public Attributes
bool(*	print_preamble )(struct print_stream *self, char *filename, const char *version_string)
	Outputs any preamble required by the print format before the first line of content.
bool(*	print_line )(struct print_stream *self, int indent, const char *line)
	Prints a single line of text at the specified indentation level.
bool(*	print_line_color )(struct print_stream *self, int indent, const char *line, const color_t *fg, const color_t *bg)
	Prints a single line of text with explicit foreground and background colors.
bool(*	print_bookmark )(struct print_stream *self, const char *name, const char *title)
	Inserts a named bookmark anchor at the current position in the output.
bool(*	new_page )(struct print_stream *self)
	Advances the output to a new page, if supported by the print format.
bool(*	print_finale )(struct print_stream *self)
	Outputs any finale or closing content required by the print format after all lines.
bool(*	destroy )(struct print_stream *self)
	Destroys the print stream and releases all associated resources.

Detailed Description

Vtable of operations implementing a print stream backend for rendering dissection output.

Member Data Documentation

destroy

bool(* print_stream_ops::destroy) (struct print_stream *self)

Destroys the print stream and releases all associated resources.

Parameters

self	The print stream instance to destroy.

Returns

True on success, false if cleanup encountered an error.

new_page

bool(* print_stream_ops::new_page) (struct print_stream *self)

Advances the output to a new page, if supported by the print format.

Parameters

self	The print stream instance.

Returns

True on success, false on write failure.

print_bookmark

bool(* print_stream_ops::print_bookmark) (struct print_stream *self, const char *name, const char *title)

Inserts a named bookmark anchor at the current position in the output.

Parameters

self	The print stream instance.
name	Internal identifier for the bookmark.
title	Human-readable title associated with the bookmark.

Returns

True on success, false on write failure.

print_finale

bool(* print_stream_ops::print_finale) (struct print_stream *self)

Outputs any finale or closing content required by the print format after all lines.

Parameters

self	The print stream instance.

Returns

True on success, false on write failure.

print_line

bool(* print_stream_ops::print_line) (struct print_stream *self, int indent, const char *line)

Prints a single line of text at the specified indentation level.

Parameters

self	The print stream instance.
indent	Number of indentation levels to apply before the line.
line	The text content to print.

Returns

True on success, false on write failure.

print_line_color

bool(* print_stream_ops::print_line_color) (struct print_stream *self, int indent, const char *line, const color_t *fg, const color_t *bg)

Prints a single line of text with explicit foreground and background colors.

Parameters

self	The print stream instance.
indent	Number of indentation levels to apply before the line.
line	The text content to print.
fg	Foreground color to apply to the line, or NULL for default.
bg	Background color to apply to the line, or NULL for default.

Returns

True on success, false on write failure.

print_preamble

bool(* print_stream_ops::print_preamble) (struct print_stream *self, char *filename, const char *version_string)

Outputs any preamble required by the print format before the first line of content.

Parameters

self	The print stream instance.
filename	Name of the capture file being printed.
version_string	Wireshark version string to include in the preamble.

Returns

True on success, false on write failure.

---

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

• /builds/wireshark/wireshark/epan/print_stream.h