ZVBI Library  0.2.35
Data Fields
vbi_export Struct Reference

Data Fields

vbi_export_class_class
 
char * errstr
 
const char * name
 
char * network
 
char * creator
 
vbi_bool reveal
 
enum _vbi_export_target target
 
union {
   FILE *   fp
 
   int   fd
 
_handle
 
_vbi_export_write_fn * _write
 
struct {
   char *   data
 
   size_t   offset
 
   size_t   capacity
 
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

vbi_export_class* vbi_export::_class
char* vbi_export::errstr
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().

char* vbi_export::network

Generic option: Network name or NULL.

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

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().

vbi_bool vbi_export::reveal

Generic option: Reveal hidden characters.

Referenced by vbi_export_option_get(), and vbi_export_option_set().

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().

_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().

char* vbi_export::data

Pointer to the start of the buffer in memory. NULL if capacity is zero.

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

size_t vbi_export::offset

The number of bytes written into the buffer so far. Must be <= capacity.

Referenced by vbi_export_alloc(), and vbi_export_mem().

size_t vbi_export::capacity

Number of bytes we can store in the buffer, may be zero.

Call _vbi_export_grow_buffer_space() to increase the capacity. Keep in mind this may change the data pointer.

Referenced by vbi_export_alloc(), and vbi_export_mem().

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().