<!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>Search</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>Search<br>
<small>
[<a class="el" href="group__Cache.html">Page cache</a>]</small>
</h1>Search the Teletext page cache.
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="Search::vbi_search"></a>
typedef vbi_search </td><td valign=bottom><a class="el" href="group__Search.html#a0">vbi_search</a></td></tr>
<tr><td> </td><td><font size=-1><em>Opaque search context.</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__Search.html#a4">vbi_search_status</a> { <br>
<a class="el" href="group__Search.html#a4a2">VBI_SEARCH_ERROR</a> = -3,
<br>
<a class="el" href="group__Search.html#a4a3">VBI_SEARCH_CACHE_EMPTY</a>,
<br>
<a class="el" href="group__Search.html#a4a4">VBI_SEARCH_CANCELED</a>,
<br>
<a class="el" href="group__Search.html#a4a5">VBI_SEARCH_NOT_FOUND</a> = 0,
<br>
<a class="el" href="group__Search.html#a4a6">VBI_SEARCH_SUCCESS</a>
<br>
}</td></tr>
<tr><td> </td><td><font size=-1><em>Return codes of the <a class="el" href="search_8h.html#a9">vbi_search_next()</a> function.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Search the Teletext page cache.
<p>
<hr><h2>Enumeration Type Documentation</h2>
<a name="a4" doxytag="search.h::vbi_search_status"></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_search_status
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return codes of the <a class="el" href="search_8h.html#a9">vbi_search_next()</a> function.
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="a4a2" doxytag="VBI_SEARCH_ERROR"></a><em>VBI_SEARCH_ERROR</em></em> </td><td>
Pattern not found, <em>pg</em> is invalid. Another <a class="el" href="search_8h.html#a9">vbi_search_next()</a> will restart from the original starting point. </td></tr>
<tr><td valign=top><em><a name="a4a3" doxytag="VBI_SEARCH_CACHE_EMPTY"></a><em>VBI_SEARCH_CACHE_EMPTY</em></em> </td><td>
The search has been canceled by the progress function. <em>pg</em> points to the current page as in success case, except for the highlighting. Another <a class="el" href="search_8h.html#a9">vbi_search_next()</a> continues from this page. </td></tr>
<tr><td valign=top><em><a name="a4a4" doxytag="VBI_SEARCH_CANCELED"></a><em>VBI_SEARCH_CANCELED</em></em> </td><td>
No pages in the cache, <em>pg</em> is invalid. </td></tr>
<tr><td valign=top><em><a name="a4a5" doxytag="VBI_SEARCH_NOT_FOUND"></a><em>VBI_SEARCH_NOT_FOUND</em></em> </td><td>
Some error occured, condition unclear. Call <a class="el" href="search_8h.html#a8">vbi_search_delete()</a>. </td></tr>
<tr><td valign=top><em><a name="a4a6" doxytag="VBI_SEARCH_SUCCESS"></a><em>VBI_SEARCH_SUCCESS</em></em> </td><td>
Pattern found. <em>pg</em> points to the page ready for display with the pattern highlighted, <em>pg->pgno</em> etc. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Thu Jan 2 16:03:42 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>
