<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Exporting formatted Teletext and Closed Caption pages</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindex" href="examples.html">Examples</a> </center>
<hr><h1>Exporting formatted Teletext and Closed Caption pages<br>
<small>
[<a class="el" href="group__Service.html">Data Service Decoder</a>]</small>
</h1><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Modules</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group__Render.html">Teletext and Closed Caption page render functions</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="group__Exmod.html">Internal export module interface</a></td></tr>
<tr><td colspan=2><br><h2>Data Structures</h2></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structvbi__export__info.html">vbi_export_info</a></td></tr>
<tr><td> </td><td><font size=-1><em>Information about an export module.</em> <a href="structvbi__export__info.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>union </td><td valign=bottom><a class="el" href="unionvbi__option__value.html">vbi_option_value</a></td></tr>
<tr><td> </td><td><font size=-1><em>Result of an option query.</em> <a href="unionvbi__option__value.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>union </td><td valign=bottom><a class="el" href="unionvbi__option__value__ptr.html">vbi_option_value_ptr</a></td></tr>
<tr><td> </td><td><font size=-1><em>Option menu types.</em> <a href="unionvbi__option__value__ptr.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>struct </td><td valign=bottom><a class="el" href="structvbi__option__info.html">vbi_option_info</a></td></tr>
<tr><td> </td><td><font size=-1><em>Information about an export option.</em> <a href="structvbi__option__info.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef vbi_export </td><td valign=bottom><a class="el" href="group__Export.html#a0">vbi_export</a></td></tr>
<tr><td> </td><td><font size=-1><em>Export module instance, an opaque object.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>typedef vbi_export_info </td><td valign=bottom><a class="el" href="group__Export.html#a1">vbi_export_info</a></td></tr>
<tr><td> </td><td><font size=-1><em>Information about an export module.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="group__Export.html#a16">vbi_option_type</a> { <br>
<a class="el" href="group__Export.html#a16a25">VBI_OPTION_BOOL</a> = 1,
<br>
<a class="el" href="group__Export.html#a16a26">VBI_OPTION_INT</a>,
<br>
<a class="el" href="group__Export.html#a16a27">VBI_OPTION_REAL</a>,
<br>
<a class="el" href="group__Export.html#a16a28">VBI_OPTION_STRING</a>,
<br>
<a class="el" href="group__Export.html#a16a29">VBI_OPTION_MENU</a>
<br>
}</td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structvbi__export__info.html">vbi_export_info</a> * </td><td valign=bottom><a class="el" href="group__Export.html#a2">vbi_export_info_enum</a> (int index)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structvbi__export__info.html">vbi_export_info</a> * </td><td valign=bottom><a class="el" href="group__Export.html#a3">vbi_export_info_keyword</a> (const char *keyword)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structvbi__export__info.html">vbi_export_info</a> * </td><td valign=bottom><a class="el" href="group__Export.html#a4">vbi_export_info_export</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structvbi__export.html">vbi_export</a> * </td><td valign=bottom><a class="el" href="group__Export.html#a5">vbi_export_new</a> (const char *keyword, char **errstr)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="group__Export.html#a6">vbi_export_delete</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structvbi__option__info.html">vbi_option_info</a> * </td><td valign=bottom><a class="el" href="group__Export.html#a7">vbi_export_option_info_enum</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export, int index)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="structvbi__option__info.html">vbi_option_info</a> * </td><td valign=bottom><a class="el" href="group__Export.html#a8">vbi_export_option_info_keyword</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export, const char *keyword)</td></tr>
<tr><td nowrap align=right valign=top>vbi_bool </td><td valign=bottom><a class="el" href="group__Export.html#a9">vbi_export_option_set</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export, const char *keyword,...)</td></tr>
<tr><td nowrap align=right valign=top>vbi_bool </td><td valign=bottom><a class="el" href="group__Export.html#a10">vbi_export_option_get</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export, const char *keyword, <a class="el" href="unionvbi__option__value.html">vbi_option_value</a> *value)</td></tr>
<tr><td nowrap align=right valign=top>vbi_bool </td><td valign=bottom><a class="el" href="group__Export.html#a11">vbi_export_option_menu_set</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export, const char *keyword, int entry)</td></tr>
<tr><td nowrap align=right valign=top>vbi_bool </td><td valign=bottom><a class="el" href="group__Export.html#a12">vbi_export_option_menu_get</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export, const char *keyword, int *entry)</td></tr>
<tr><td nowrap align=right valign=top>vbi_bool </td><td valign=bottom><a class="el" href="group__Export.html#a13">vbi_export_stdio</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export, FILE *fp, <a class="el" href="structvbi__page.html">vbi_page</a> *pg)</td></tr>
<tr><td nowrap align=right valign=top>vbi_bool </td><td valign=bottom><a class="el" href="group__Export.html#a14">vbi_export_file</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export, const char *name, <a class="el" href="structvbi__page.html">vbi_page</a> *pg)</td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="group__Export.html#a15">vbi_export_errstr</a> (<a class="el" href="structvbi__export.html">vbi_export</a> *export)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Once libzvbi received, decoded and formatted a Teletext or Closed Caption page you will want to render it on screen, print it as text or store it in various formats.
<p>
Fortunately you don't have to do it all by yourself. libzvbi provides export modules converting a <a class="el" href="structvbi__page.html">vbi_page</a> into the desired format or rendering directly into memory.
<p>
A minimalistic export example:
<p>
<div class="fragment"><pre> <span class="keyword">static</span> <span class="keywordtype">void</span>
export_my_page (<a class="code" href="structvbi__page.html">vbi_page</a> *pg)
{
<a class="code" href="structvbi__export.html">vbi_export</a> *ex;
<span class="keywordtype">char</span> *errstr;
<span class="keywordflow">if</span> (!(ex = <a class="code" href="group__Export.html#a5">vbi_export_new</a> (<span class="stringliteral">"html"</span>, &errstr))) {
fprintf (stderr, <span class="stringliteral">"Cannot export as HTML: %s\n"</span>, errstr);
free (errstr);
<span class="keywordflow">return</span>;
}
<span class="keywordflow">if</span> (!<a class="code" href="group__Export.html#a14">vbi_export_file</a> (ex, <span class="stringliteral">"my_page.html"</span>, pg))
puts (vbi_export_errstr (ex));
<a class="code" href="group__Export.html#a6">vbi_export_delete</a> (ex);
}
</pre></div> <hr><h2>Typedef Documentation</h2>
<a name="a0" doxytag="export.h::vbi_export"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef struct vbi_export vbi_export
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Export module instance, an opaque object.
<p>
Allocate with <a class="el" href="group__Export.html#a5">vbi_export_new()</a>. </td>
</tr>
</table>
<a name="a1" doxytag="export.h::vbi_export_info"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> typedef struct vbi_export_info vbi_export_info
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Information about an export module.
<p>
Although export modules can be accessed by a static keyword (see <a class="el" href="group__Export.html#a5">vbi_export_new()</a>) they are by definition opaque. The client can list export modules for the user and manipulate them without knowing about their availability or purpose. To do so, information about the module is necessary, given in this structure.
<p>
You can obtain this information with <a class="el" href="group__Export.html#a2">vbi_export_info_enum()</a>. </td>
</tr>
</table>
<hr><h2>Enumeration Type Documentation</h2>
<a name="a16" doxytag="export.h::vbi_option_type"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> enum vbi_option_type
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="a16a25" doxytag="VBI_OPTION_BOOL"></a><em>VBI_OPTION_BOOL</em></em> </td><td>
A boolean value, either <code>TRUE</code> (1) or <code>FALSE</code> (0). <table border=1 cellspacing=3 cellpadding=3><tr><td>Type:</td><td>int </td></tr>
<tr><td>Default:</td><td>def.num </td></tr>
<tr><td>Bounds:</td><td>min.num (0) ... max.num (1), step.num (1) </td></tr>
<tr><td>Menu:</td><td>NULL </td></tr></table>
</td></tr>
<tr><td valign=top><em><a name="a16a26" doxytag="VBI_OPTION_INT"></a><em>VBI_OPTION_INT</em></em> </td><td>
A signed integer value. When only a few discrete values rather than a range are permitted <code>menu</code> points to a vector of integers. Note the option is still set by value, not by menu index. Setting the value may fail, or it may be replaced by the closest possible. <table border=1 cellspacing=3 cellpadding=3><tr><td>Type:</td><td>int </td></tr>
<tr><td>Default:</td><td>def.num or menu.num[def.num] </td></tr>
<tr><td>Bounds:</td><td>min.num ... max.num, step.num or menu </td></tr>
<tr><td>Menu:</td><td>NULL or menu.num[min.num ... max.num], step.num (1) </td></tr></table>
</td></tr>
<tr><td valign=top><em><a name="a16a27" doxytag="VBI_OPTION_REAL"></a><em>VBI_OPTION_REAL</em></em> </td><td>
A real value, optional a vector of suggested values. <table border=1 cellspacing=3 cellpadding=3><tr><td>Type:</td><td>double </td></tr>
<tr><td>Default:</td><td>def.dbl or menu.dbl[def.num] </td></tr>
<tr><td>Bounds:</td><td>min.dbl ... max.dbl, step.dbl or menu </td></tr>
<tr><td>Menu:</td><td>NULL or menu.dbl[min.num ... max.num], step.num (1) </td></tr></table>
</td></tr>
<tr><td valign=top><em><a name="a16a28" doxytag="VBI_OPTION_STRING"></a><em>VBI_OPTION_STRING</em></em> </td><td>
A null terminated string. Note the menu version differs from VBI_OPTION_MENU in its argument, which is the string itself. For example: <div class="fragment"><pre> menu.str[0] = <span class="stringliteral">"red"</span>
menu.str[1] = <span class="stringliteral">"blue"</span>
... and the option may accept other color strings not explicitely listed
</pre></div> <table border=1 cellspacing=3 cellpadding=3><tr><td>Type:</td><td>char * </td></tr>
<tr><td>Default:</td><td>def.str or menu.str[def.num] </td></tr>
<tr><td>Bounds:</td><td>not applicable </td></tr>
<tr><td>Menu:</td><td>NULL or menu.str[min.num ... max.num], step.num (1) </td></tr></table>
</td></tr>
<tr><td valign=top><em><a name="a16a29" doxytag="VBI_OPTION_MENU"></a><em>VBI_OPTION_MENU</em></em> </td><td>
Choice between a number of named options. For example: <div class="fragment"><pre> menu.str[0] = <span class="stringliteral">"up"</span>
menu.str[1] = <span class="stringliteral">"down"</span>
menu.str[2] = <span class="stringliteral">"strange"</span>
</pre></div> <table border=1 cellspacing=3 cellpadding=3><tr><td>Type:</td><td>int </td></tr>
<tr><td>Default:</td><td>def.num </td></tr>
<tr><td>Bounds:</td><td>min.num (0) ... max.num, step.num (1) </td></tr>
<tr><td>Menu:</td><td>menu.str[min.num ... max.num], step.num (1). The menu strings are nationalized N_("text"), client applications are encouraged to localize with dgettext("zvbi", menu.str[n]). For details see info gettext. </td></tr></table>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a2" doxytag="export.c::vbi_export_info_enum"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structvbi__export__info.html">vbi_export_info</a>* vbi_export_info_enum </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>index</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>index</em> </td><td>
Index into the export module list, 0 ... n.</td></tr>
</table>
</dl>Enumerates all available export modules. You should start at index 0, incrementing.
<p>
Some modules may depend on machine features or the presence of certain libraries, thus the list can vary from session to session.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Static pointer to a <a class="el" href="structvbi__export__info.html">vbi_export_info</a> structure (no need to be freed), <code>NULL</code> if the index is out of bounds. </dl> </td>
</tr>
</table>
<a name="a3" doxytag="export.c::vbi_export_info_keyword"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structvbi__export__info.html">vbi_export_info</a>* vbi_export_info_keyword </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>keyword</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keyword</em> </td><td>
Export module identifier as in <a class="el" href="structvbi__export__info.html">vbi_export_info</a> and <a class="el" href="group__Export.html#a5">vbi_export_new()</a>.</td></tr>
</table>
</dl>Similar to <a class="el" href="group__Export.html#a2">vbi_export_info_enum()</a>, but this function attempts to find an export module by keyword.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Static pointer to a <a class="el" href="structvbi__export__info.html">vbi_export_info</a> structure, <code>NULL</code> if the named export module has not been found. </dl> </td>
</tr>
</table>
<a name="a4" doxytag="export.c::vbi_export_info_export"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structvbi__export__info.html">vbi_export_info</a>* vbi_export_info_export </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>export</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a <a class="el" href="structvbi__export.html">vbi_export</a> object previously allocated with <a class="el" href="group__Export.html#a5">vbi_export_new()</a>.</td></tr>
</table>
</dl>Returns the export module info for the given <em>export</em> object.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
A static <a class="el" href="structvbi__export__info.html">vbi_export_info</a> pointer or <code>NULL</code> if <em>export</em> is <code>NULL</code>. </dl> </td>
</tr>
</table>
<a name="a5" doxytag="export.c::vbi_export_new"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structvbi__export.html">vbi_export</a>* vbi_export_new </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>keyword</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>char ** </td>
<td class="mdname" nowrap> <em>errstr</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keyword</em> </td><td>
Export module identifier as in <a class="el" href="structvbi__export__info.html">vbi_export_info</a>. </td></tr>
<tr><td valign=top><em>errstr</em> </td><td>
If not <code>NULL</code> this function stores a pointer to an error description here. You must free() this string when no longer needed.</td></tr>
</table>
</dl>Creates a new export module instance to export a <a class="el" href="structvbi__page.html">vbi_page</a> in the respective module format. As a special service you can initialize options by appending to the <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keyword</em> </td><td>
like this:</td></tr>
</table>
</dl><div class="fragment"><pre> <a class="code" href="group__Export.html#a5">vbi_export_new</a> (<span class="stringliteral">"keyword; quality=75.5, comment=\"example text\""</span>);
</pre></div>
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Pointer to a newly allocated <a class="el" href="structvbi__export.html">vbi_export</a> object which must be freed by calling <a class="el" href="group__Export.html#a6">vbi_export_delete()</a>. <code>NULL</code> is returned and the <em>errstr</em> may be set (else <em>NULL)</em> if some problem occurred. </dl> </td>
</tr>
</table>
<a name="a6" doxytag="export.c::vbi_export_delete"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void vbi_export_delete </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>export</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a <a class="el" href="structvbi__export.html">vbi_export</a> object previously allocated with <a class="el" href="group__Export.html#a5">vbi_export_new()</a>. Can be <code>NULL</code>.</td></tr>
</table>
</dl>This function frees all resources associated with the <a class="el" href="structvbi__export.html">vbi_export</a> object. </td>
</tr>
</table>
<a name="a7" doxytag="export.c::vbi_export_option_info_enum"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structvbi__option__info.html">vbi_option_info</a>* vbi_export_option_info_enum </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname" nowrap> <em>export</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>index</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a initialized <a class="el" href="structvbi__export.html">vbi_export</a> object. </td></tr>
<tr><td valign=top><em>index</em> </td><td>
Index in the option table 0 ... n.</td></tr>
</table>
</dl>Enumerates the options available for the given export module. You should start at index 0, incrementing.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Static pointer to a <a class="el" href="structvbi__option__info.html">vbi_option_info</a> structure, <code>NULL</code> if <em>index</em> is out of bounds. </dl> </td>
</tr>
</table>
<a name="a8" doxytag="export.c::vbi_export_option_info_keyword"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="structvbi__option__info.html">vbi_option_info</a>* vbi_export_option_info_keyword </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname" nowrap> <em>export</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>keyword</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a initialized <a class="el" href="structvbi__export.html">vbi_export</a> object. </td></tr>
<tr><td valign=top><em>keyword</em> </td><td>
Keyword of the option as in <a class="el" href="structvbi__option__info.html">vbi_option_info</a>.</td></tr>
</table>
</dl>Similar to <a class="el" href="group__Export.html#a7">vbi_export_option_info_enum()</a>, but tries to find the option info based on the given keyword.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
Static pointer to a <a class="el" href="structvbi__option__info.html">vbi_option_info</a> structure, <code>NULL</code> if the keyword wasn't found. </dl> </td>
</tr>
</table>
<a name="a9" doxytag="export.c::vbi_export_option_set"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> vbi_bool vbi_export_option_set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname" nowrap> <em>export</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>keyword</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>... </td>
<td class="mdname" nowrap> </td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a initialized <a class="el" href="structvbi__export.html">vbi_export</a> object. </td></tr>
<tr><td valign=top><em>keyword</em> </td><td>
Keyword identifying the option, as in <a class="el" href="structvbi__option__info.html">vbi_option_info</a>. </td></tr>
<tr><td valign=top><em>Varargs</em> </td><td>
New value to set.</td></tr>
</table>
</dl>Sets the value of the named option. Make sure the value is casted to the correct type (int, double, char *).
<p>
Typical usage of <a class="el" href="group__Export.html#a9">vbi_export_option_set()</a>: <div class="fragment"><pre> <a class="code" href="group__Export.html#a9">vbi_export_option_set</a> (export, <span class="stringliteral">"quality"</span>, 75.5);
</pre></div>
<p>
Mind that options of type <code>VBI_OPTION_MENU</code> must be set by menu entry number (int), all other options by value. If necessary it will be replaced by the closest value possible. Use function <a class="el" href="group__Export.html#a11">vbi_export_option_menu_set()</a> to set options with menu by menu entry.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
<code>TRUE</code> on success, otherwise the option is not changed. </dl> </td>
</tr>
</table>
<a name="a10" doxytag="export.c::vbi_export_option_get"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> vbi_bool vbi_export_option_get </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname" nowrap> <em>export</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>keyword</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> * </td>
<td class="mdname" nowrap> <em>value</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a initialized <a class="el" href="structvbi__export.html">vbi_export</a> object. </td></tr>
<tr><td valign=top><em>keyword</em> </td><td>
Keyword identifying the option, as in <a class="el" href="structvbi__option__info.html">vbi_option_info</a>. </td></tr>
<tr><td valign=top><em>value</em> </td><td>
A place to store the current option value.</td></tr>
</table>
</dl>This function queries the current value of the named option. When the option is of type VBI_OPTION_STRING <em>value.str</em> must be freed with free() when you don't need it any longer. When the option is of type VBI_OPTION_MENU then <em>value.num</em> contains the selected entry.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
<code>TRUE</code> on success, otherwise <em>value</em> unchanged. </dl> </td>
</tr>
</table>
<a name="a11" doxytag="export.c::vbi_export_option_menu_set"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> vbi_bool vbi_export_option_menu_set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname" nowrap> <em>export</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>keyword</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>entry</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a initialized <a class="el" href="structvbi__export.html">vbi_export</a> object. </td></tr>
<tr><td valign=top><em>keyword</em> </td><td>
Keyword identifying the option, as in <a class="el" href="structvbi__option__info.html">vbi_option_info</a>. </td></tr>
<tr><td valign=top><em>entry</em> </td><td>
Menu entry to be selected.</td></tr>
</table>
</dl>Similar to <a class="el" href="group__Export.html#a9">vbi_export_option_set()</a> this function sets the value of the named option, however it does so by number of the corresponding menu entry. Naturally this must be an option with menu.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
<code>TRUE</code> on success, otherwise the option is not changed. </dl> </td>
</tr>
</table>
<a name="a12" doxytag="export.c::vbi_export_option_menu_get"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> vbi_bool vbi_export_option_menu_get </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname" nowrap> <em>export</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>keyword</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int * </td>
<td class="mdname" nowrap> <em>entry</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a initialized <a class="el" href="structvbi__export.html">vbi_export</a> object. </td></tr>
<tr><td valign=top><em>keyword</em> </td><td>
Keyword identifying the option, as in <a class="el" href="structvbi__option__info.html">vbi_option_info</a>. </td></tr>
<tr><td valign=top><em>entry</em> </td><td>
A place to store the current menu entry.</td></tr>
</table>
</dl>Similar to <a class="el" href="group__Export.html#a10">vbi_export_option_get()</a> this function queries the current value of the named option, but returns this value as number of the corresponding menu entry. Naturally this must be an option with menu.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
<code>TRUE</code> on success, otherwise <em>value</em> remained unchanged. </dl> </td>
</tr>
</table>
<a name="a13" doxytag="export.c::vbi_export_stdio"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> vbi_bool vbi_export_stdio </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname" nowrap> <em>export</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>FILE * </td>
<td class="mdname" nowrap> <em>fp</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="structvbi__page.html">vbi_page</a> * </td>
<td class="mdname" nowrap> <em>pg</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a initialized <a class="el" href="structvbi__export.html">vbi_export</a> object. </td></tr>
<tr><td valign=top><em>fp</em> </td><td>
Buffered i/o stream to write to. </td></tr>
<tr><td valign=top><em>pg</em> </td><td>
Page to be exported.</td></tr>
</table>
</dl>This function writes the <em>pg</em> contents, converted to the respective export module format, to the stream <em>fp</em>. The caller is responsible for opening and closing the stream, don't forget to check for i/o errors after closing. Note this function may write incomplete files when an error occurs.
<p>
You can call this function as many times as you want, it does not change <a class="el" href="structvbi__export.html">vbi_export</a> state or the <a class="el" href="structvbi__page.html">vbi_page</a>.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
<code>TRUE</code> on success. </dl> </td>
</tr>
</table>
<a name="a14" doxytag="export.c::vbi_export_file"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> vbi_bool vbi_export_file </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname" nowrap> <em>export</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>name</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="structvbi__page.html">vbi_page</a> * </td>
<td class="mdname" nowrap> <em>pg</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a initialized <a class="el" href="structvbi__export.html">vbi_export</a> object. </td></tr>
<tr><td valign=top><em>name</em> </td><td>
File to be created. </td></tr>
<tr><td valign=top><em>pg</em> </td><td>
Page to be exported.</td></tr>
</table>
</dl>This function writes the <em>pg</em> contents, converted to the respective export format, into a new file of the given <em>name</em>. When an error occured the incomplete file will be deleted.
<p>
You can call this function as many times as you want, it does not change <a class="el" href="structvbi__export.html">vbi_export</a> state or the <a class="el" href="structvbi__page.html">vbi_page</a>.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
<code>TRUE</code> on success. </dl> </td>
</tr>
</table>
<a name="a15" doxytag="export.c::vbi_export_errstr"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* vbi_export_errstr </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="structvbi__export.html">vbi_export</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>export</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>export</em> </td><td>
Pointer to a initialized <a class="el" href="structvbi__export.html">vbi_export</a> object.</td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
After an export function failed, this function returns a pointer to a more detailed error description. Do not free this string. It remains valid until the next call of an export function. </dl> </td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Thu Jan 2 16:03:41 2003 for ZVBI Library by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>
