Main Page   Modules   Data Structures   Data Fields   Related Pages   Examples  

Basic types


Boolean type

#define TRUE   1
#define FALSE   0
typedef int vbi_bool

Enumerations

enum  vbi_log_mask {
  VBI_LOG_ERROR = 1 << 3,
  VBI_LOG_WARNING = 1 << 4,
  VBI_LOG_NOTICE = 1 << 5,
  VBI_LOG_INFO = 1 << 6,
  VBI_LOG_DEBUG = 1 << 7,
  VBI_LOG_DRIVER = 1 << 8,
  VBI_LOG_DEBUG2 = 1 << 9,
  VBI_LOG_DEBUG3 = 1 << 10
}

Functions

void vbi_log_on_stderr (vbi_log_mask level, const char *context, const char *message, void *user_data)
void vbi_set_log_fn (vbi_log_mask mask, vbi_log_fn *log_fn, void *user_data)
void vbi_version (unsigned int *major, unsigned int *minor, unsigned int *micro)

Variables

vbi_log_fn vbi_log_on_stderr

Enumeration Type Documentation

enum vbi_log_mask
 

Enumeration values:
VBI_LOG_ERROR   External error causes, for example lack of memory.
VBI_LOG_WARNING   Invalid parameters and similar problems which suggest a bug in the caller.
VBI_LOG_NOTICE   Causes of possibly undesired results, for example when a data service cannot be decoded with the current video standard.
VBI_LOG_INFO   Progress messages.
VBI_LOG_DEBUG   Information useful to debug the library.
VBI_LOG_DRIVER   Driver responses (strace). Not implemented yet.
VBI_LOG_DEBUG2   More detailed debugging information.


Function Documentation

void vbi_log_on_stderr ( vbi_log_mask level,
const char * context,
const char * message,
void * user_data )
 

Log function printing messages on standard output.

Since:
0.2.22

void vbi_set_log_fn ( vbi_log_mask mask,
vbi_log_fn * log_fn,
void * user_data )
 

Parameters:
mask   Which kind of information to log. Can be 0.
log_fn   This function is called with log messages. Consider vbi_log_on_stderr(). Can be NULL to disable logging.
user_data   User pointer passed through to the log_fn function.

Various functions can print warnings, errors and information useful to debug the library. With this function you can enable these messages and determine a function to print them.

Note:
The kind and contents of messages logged by particular functions may change in the future.

Since:
0.2.22

void vbi_version ( unsigned int * major,
unsigned int * minor,
unsigned int * micro )
 

Parameters:
major   Store major number here, can be NULL.
minor   Store minor number here, can be NULL.
micro   Store micro number here, can be NULL.

Returns the library version defined in the libzvbi.h header file when the library was compiled.

Since:
0.2.5


Variable Documentation

void vbi_log_on_stderr
 

Log function printing messages on standard output.

Since:
0.2.22


Generated at Sun Sep 14 21:21:05 2008 for ZVBI Library by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001