<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>ZVBI Library: Basic types</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> </div> <div class="contents"> <h1>Basic types</h1><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Basic.html#g892c64da1c60919512f0c4db6641a708">vbi_log_on_stderr</a> (<a class="el" href="group__Basic.html#g14be5ab1155e94b01c79a4ed044e64ac">vbi_log_mask</a> level, const char *context, const char *message, void *user_data)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Basic.html#g594dbe49c85f00a11c3586a131203b61">vbi_set_log_fn</a> (<a class="el" href="group__Basic.html#g14be5ab1155e94b01c79a4ed044e64ac">vbi_log_mask</a> mask, vbi_log_fn *log_fn, void *user_data)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Basic.html#gf2e31cbf38e933d930d1bcbe4b259caa">vbi_version</a> (unsigned int *major, unsigned int *minor, unsigned int *micro)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Basic.html#g14be5ab1155e94b01c79a4ed044e64ac">vbi_log_mask</a> { <br> <a class="el" href="group__Basic.html#gg14be5ab1155e94b01c79a4ed044e64ac07b09f3b08a81ce12ac0a515978b56e2">VBI_LOG_ERROR</a> = 1 << 3, <br> <a class="el" href="group__Basic.html#gg14be5ab1155e94b01c79a4ed044e64ac36d1d236c051fc0db20ccdec56a19596">VBI_LOG_WARNING</a> = 1 << 4, <br> <a class="el" href="group__Basic.html#gg14be5ab1155e94b01c79a4ed044e64ac6b8552ba1cf85168196a872f9fb11c3a">VBI_LOG_NOTICE</a> = 1 << 5, <br> <a class="el" href="group__Basic.html#gg14be5ab1155e94b01c79a4ed044e64ac0f40608aab3215669b18ba31d3cc7f3a">VBI_LOG_INFO</a> = 1 << 6, <br> <a class="el" href="group__Basic.html#gg14be5ab1155e94b01c79a4ed044e64ac6a2eef6084bf0876d72e81e4f7fb0c3f">VBI_LOG_DEBUG</a> = 1 << 7, <br> <a class="el" href="group__Basic.html#gg14be5ab1155e94b01c79a4ed044e64ac19a4025bfa4d039fe5c37adfa0b7eead">VBI_LOG_DRIVER</a> = 1 << 8, <br> <a class="el" href="group__Basic.html#gg14be5ab1155e94b01c79a4ed044e64ac8709d20a4b667a1a1b668dd83003c3ed">VBI_LOG_DEBUG2</a> = 1 << 9, <br> <b>VBI_LOG_DEBUG3</b> = 1 << 10 <br> }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf2c087cb2bbe662a71bfa0b7f990498a"></a><!-- doxytag: member="Basic::vbi_log_fn" ref="gf2c087cb2bbe662a71bfa0b7f990498a" args="(vbi_log_mask level, const char *context, const char *message, void *user_data)" --> typedef void </td><td class="memItemRight" valign="bottom"><b>vbi_log_fn</b> (<a class="el" href="group__Basic.html#g14be5ab1155e94b01c79a4ed044e64ac">vbi_log_mask</a> level, const char *context, const char *message, void *user_data)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0b182ed200f1fbe2f59f859b25878b0b"></a><!-- doxytag: member="Basic::vbi_log_on_stderr" ref="g0b182ed200f1fbe2f59f859b25878b0b" args="" --> vbi_log_fn </td><td class="memItemRight" valign="bottom"><b>vbi_log_on_stderr</b></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <hr><h2>Enumeration Type Documentation</h2> <a class="anchor" name="g14be5ab1155e94b01c79a4ed044e64ac"></a><!-- doxytag: member="macros.h::vbi_log_mask" ref="g14be5ab1155e94b01c79a4ed044e64ac" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="group__Basic.html#g14be5ab1155e94b01c79a4ed044e64ac">vbi_log_mask</a> </td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"><em><a class="anchor" name="gg14be5ab1155e94b01c79a4ed044e64ac07b09f3b08a81ce12ac0a515978b56e2"></a><!-- doxytag: member="VBI_LOG_ERROR" ref="gg14be5ab1155e94b01c79a4ed044e64ac07b09f3b08a81ce12ac0a515978b56e2" args="" -->VBI_LOG_ERROR</em> </td><td> External error causes, for example lack of memory. </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg14be5ab1155e94b01c79a4ed044e64ac36d1d236c051fc0db20ccdec56a19596"></a><!-- doxytag: member="VBI_LOG_WARNING" ref="gg14be5ab1155e94b01c79a4ed044e64ac36d1d236c051fc0db20ccdec56a19596" args="" -->VBI_LOG_WARNING</em> </td><td> Invalid parameters and similar problems which suggest a bug in the caller. </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg14be5ab1155e94b01c79a4ed044e64ac6b8552ba1cf85168196a872f9fb11c3a"></a><!-- doxytag: member="VBI_LOG_NOTICE" ref="gg14be5ab1155e94b01c79a4ed044e64ac6b8552ba1cf85168196a872f9fb11c3a" args="" -->VBI_LOG_NOTICE</em> </td><td> Causes of possibly undesired results, for example when a data service cannot be decoded with the current video standard. </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg14be5ab1155e94b01c79a4ed044e64ac0f40608aab3215669b18ba31d3cc7f3a"></a><!-- doxytag: member="VBI_LOG_INFO" ref="gg14be5ab1155e94b01c79a4ed044e64ac0f40608aab3215669b18ba31d3cc7f3a" args="" -->VBI_LOG_INFO</em> </td><td> Progress messages. </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg14be5ab1155e94b01c79a4ed044e64ac6a2eef6084bf0876d72e81e4f7fb0c3f"></a><!-- doxytag: member="VBI_LOG_DEBUG" ref="gg14be5ab1155e94b01c79a4ed044e64ac6a2eef6084bf0876d72e81e4f7fb0c3f" args="" -->VBI_LOG_DEBUG</em> </td><td> Information useful to debug the library. </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg14be5ab1155e94b01c79a4ed044e64ac19a4025bfa4d039fe5c37adfa0b7eead"></a><!-- doxytag: member="VBI_LOG_DRIVER" ref="gg14be5ab1155e94b01c79a4ed044e64ac19a4025bfa4d039fe5c37adfa0b7eead" args="" -->VBI_LOG_DRIVER</em> </td><td> Driver responses (strace). Not implemented yet. </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg14be5ab1155e94b01c79a4ed044e64ac8709d20a4b667a1a1b668dd83003c3ed"></a><!-- doxytag: member="VBI_LOG_DEBUG2" ref="gg14be5ab1155e94b01c79a4ed044e64ac8709d20a4b667a1a1b668dd83003c3ed" args="" -->VBI_LOG_DEBUG2</em> </td><td> More detailed debugging information. </td></tr> </table> </dl> </div> </div><p> <hr><h2>Function Documentation</h2> <a class="anchor" name="g892c64da1c60919512f0c4db6641a708"></a><!-- doxytag: member="misc.c::vbi_log_on_stderr" ref="g892c64da1c60919512f0c4db6641a708" args="(vbi_log_mask level, const char *context, const char *message, void *user_data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vbi_log_on_stderr </td> <td>(</td> <td class="paramtype"><a class="el" href="group__Basic.html#g14be5ab1155e94b01c79a4ed044e64ac">vbi_log_mask</a> </td> <td class="paramname"> <em>level</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>context</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"> <em>message</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"> <em>user_data</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Log function printing messages on standard output.<p> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.22 </dd></dl> <dl compact><dt><b>Examples: </b></dt><dd> <a class="el" href="examples_2rawout_8c-example.html#a10">examples/rawout.c</a>, and <a class="el" href="examples_2wss_8c-example.html#a15">examples/wss.c</a>.</dl> </div> </div><p> <a class="anchor" name="g594dbe49c85f00a11c3586a131203b61"></a><!-- doxytag: member="vbi.c::vbi_set_log_fn" ref="g594dbe49c85f00a11c3586a131203b61" args="(vbi_log_mask mask, vbi_log_fn *log_fn, void *user_data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vbi_set_log_fn </td> <td>(</td> <td class="paramtype"><a class="el" href="group__Basic.html#g14be5ab1155e94b01c79a4ed044e64ac">vbi_log_mask</a> </td> <td class="paramname"> <em>mask</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">vbi_log_fn * </td> <td class="paramname"> <em>log_fn</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void * </td> <td class="paramname"> <em>user_data</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>mask</em> </td><td>Which kind of information to log. Can be <code>0</code>. </td></tr> <tr><td valign="top"></td><td valign="top"><em>log_fn</em> </td><td>This function is called with log messages. Consider <a class="el" href="group__Basic.html#g892c64da1c60919512f0c4db6641a708">vbi_log_on_stderr()</a>. Can be <code>NULL</code> to disable logging. </td></tr> <tr><td valign="top"></td><td valign="top"><em>user_data</em> </td><td>User pointer passed through to the <em>log_fn</em> function.</td></tr> </table> </dl> 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.<p> <dl class="note" compact><dt><b>Note:</b></dt><dd>The kind and contents of messages logged by particular functions may change in the future.</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.22 </dd></dl> <dl compact><dt><b>Examples: </b></dt><dd> <a class="el" href="examples_2rawout_8c-example.html#a6">examples/rawout.c</a>, and <a class="el" href="examples_2wss_8c-example.html#a14">examples/wss.c</a>.</dl> </div> </div><p> <a class="anchor" name="gf2e31cbf38e933d930d1bcbe4b259caa"></a><!-- doxytag: member="vbi.c::vbi_version" ref="gf2e31cbf38e933d930d1bcbe4b259caa" args="(unsigned int *major, unsigned int *minor, unsigned int *micro)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void vbi_version </td> <td>(</td> <td class="paramtype">unsigned int * </td> <td class="paramname"> <em>major</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int * </td> <td class="paramname"> <em>minor</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int * </td> <td class="paramname"> <em>micro</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>major</em> </td><td>Store major number here, can be NULL. </td></tr> <tr><td valign="top"></td><td valign="top"><em>minor</em> </td><td>Store minor number here, can be NULL. </td></tr> <tr><td valign="top"></td><td valign="top"><em>micro</em> </td><td>Store micro number here, can be NULL.</td></tr> </table> </dl> Returns the library version defined in the libzvbi.h header file when the library was compiled.<p> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.2.5 </dd></dl> </div> </div><p> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 04:47:58 2009 for ZVBI Library by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> </body> </html>