vbi_export Struct Reference

#include <export.h>

Data Structures
union	[union]._handle
struct	[struct].buffer

Data Fields
vbi_export_class *	_class
char *	errstr
const char *	name
char *	network
char *	creator
vbi_bool	reveal
enum _vbi_export_target	target
union	_handle
_vbi_export_write_fn *	_write
struct	buffer
vbi_bool	write_error

Detailed Description

Structure representing an export module instance, part of the private export module interface.

Export modules can read, but do not normally write its fields, as they are maintained by the public libzvbi export functions.

Examples

src/exp-templ.c.

Field Documentation

_class

vbi_export_class* vbi_export::_class

Points back to export module description.

Referenced by vbi_export_alloc(), vbi_export_file(), vbi_export_mem(), vbi_export_new(), and vbi_export_stdio().

errstr

char* vbi_export::errstr

Frontend private.

Referenced by vbi_export_delete(), vbi_export_errstr(), and vbi_export_new().

name

const char* vbi_export::name

If target is VBI_EXPORT_FILE the name of the file we are writing to, as supplied by the client. Otherwise NULL. This is intended for debugging and error messages.

Referenced by vbi_export_file(), vbi_export_new(), and vbi_export_write_error().

network

char* vbi_export::network

Generic option: Network name or NULL.

Referenced by vbi_export_delete(), vbi_export_option_get(), and vbi_export_option_set().

creator

char* vbi_export::creator

Generic option: Creator name [by default "libzvbi"] or NULL.

Referenced by vbi_export_delete(), vbi_export_option_get(), and vbi_export_option_set().

reveal

vbi_bool vbi_export::reveal

Generic option: Reveal hidden characters.

target

enum _vbi_export_target vbi_export::target

The export target. Note _vbi_export_grow_buffer_space() may change the target from TARGET_MEM to TARGET_ALLOC if the buffer supplied by the application is too small.

Referenced by vbi_export_alloc(), vbi_export_file(), vbi_export_mem(), and vbi_export_stdio().

_write

_vbi_export_write_fn* vbi_export::_write

Function to write data into _handle.

Private field. Not to be accessed by export modules.

Referenced by vbi_export_alloc(), vbi_export_file(), vbi_export_mem(), and vbi_export_stdio().

write_error

vbi_bool vbi_export::write_error

A write error occurred (like ferror()).

Referenced by vbi_export_alloc(), vbi_export_file(), vbi_export_mem(), and vbi_export_stdio().