<!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: Search</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>Search<br> <small> [<a class="el" href="group__Cache.html">Cache</a>]</small> </h1>Search the Teletext page cache. <a href="#_details">More...</a> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g0100d81e5ac9ed6d9056ca725f5e7cdd"></a><!-- doxytag: member="Search::vbi_search" ref="g0100d81e5ac9ed6d9056ca725f5e7cdd" args="" --> typedef struct <a class="el" href="group__Search.html#g0100d81e5ac9ed6d9056ca725f5e7cdd">vbi_search</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Search.html#g0100d81e5ac9ed6d9056ca725f5e7cdd">vbi_search</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque search context. <br></td></tr> <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Search.html#g32cfe12eb9cbd23ee3a972ecc678a75a">vbi_search_status</a> { <br> <a class="el" href="group__Search.html#gg32cfe12eb9cbd23ee3a972ecc678a75a644d544ee96768f3e46e4da1dd928d13">VBI_SEARCH_ERROR</a> = -3, <br> <a class="el" href="group__Search.html#gg32cfe12eb9cbd23ee3a972ecc678a75a5b44d23d1909bf92a4381b88fe6fdbbf">VBI_SEARCH_CACHE_EMPTY</a>, <br> <a class="el" href="group__Search.html#gg32cfe12eb9cbd23ee3a972ecc678a75a7249d87f362cb808eb442498409dc5ba">VBI_SEARCH_CANCELED</a>, <br> <a class="el" href="group__Search.html#gg32cfe12eb9cbd23ee3a972ecc678a75a73842cc78e2fb97059e2fabf5c6e69de">VBI_SEARCH_NOT_FOUND</a> = 0, <br> <a class="el" href="group__Search.html#gg32cfe12eb9cbd23ee3a972ecc678a75ad27f98e1ac2798333fb721f0ec58a42c">VBI_SEARCH_SUCCESS</a> <br> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return codes of the vbi_search_next() function. <a href="group__Search.html#g32cfe12eb9cbd23ee3a972ecc678a75a">More...</a><br></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbf8a91f6c2b1adf3b410e1179cbaf2bf"></a><!-- doxytag: member="Search::vbi_search_new" ref="gbf8a91f6c2b1adf3b410e1179cbaf2bf" args="(vbi_decoder *vbi, vbi_pgno pgno, vbi_subno subno, uint16_t *pattern, vbi_bool casefold, vbi_bool regexp, int(*progress)(vbi_page *pg))" --> <a class="el" href="group__Search.html#g0100d81e5ac9ed6d9056ca725f5e7cdd">vbi_search</a> * </td><td class="memItemRight" valign="bottom"><b>vbi_search_new</b> (vbi_decoder *vbi, <a class="el" href="group__HiDec.html#g8711c9b42b61d518b7f79e941fe94eb1">vbi_pgno</a> pgno, <a class="el" href="group__HiDec.html#g06ee2e75548bbd0fcca06a71395c940e">vbi_subno</a> subno, uint16_t *pattern, vbi_bool casefold, vbi_bool regexp, int(*progress)(<a class="el" href="structvbi__page.html">vbi_page</a> *pg))</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbd875dfeeff00a774e3e78f8d395767a"></a><!-- doxytag: member="Search::vbi_search_delete" ref="gbd875dfeeff00a774e3e78f8d395767a" args="(vbi_search *search)" --> void </td><td class="memItemRight" valign="bottom"><b>vbi_search_delete</b> (<a class="el" href="group__Search.html#g0100d81e5ac9ed6d9056ca725f5e7cdd">vbi_search</a> *search)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3d9a7b9d687238776344cca80740050e"></a><!-- doxytag: member="Search::vbi_search_next" ref="g3d9a7b9d687238776344cca80740050e" args="(vbi_search *search, vbi_page **pg, int dir)" --> <a class="el" href="group__Search.html#g32cfe12eb9cbd23ee3a972ecc678a75a">vbi_search_status</a> </td><td class="memItemRight" valign="bottom"><b>vbi_search_next</b> (<a class="el" href="group__Search.html#g0100d81e5ac9ed6d9056ca725f5e7cdd">vbi_search</a> *search, <a class="el" href="structvbi__page.html">vbi_page</a> **pg, int dir)</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Search the Teletext page cache. <hr><h2>Enumeration Type Documentation</h2> <a class="anchor" name="g32cfe12eb9cbd23ee3a972ecc678a75a"></a><!-- doxytag: member="search.h::vbi_search_status" ref="g32cfe12eb9cbd23ee3a972ecc678a75a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="group__Search.html#g32cfe12eb9cbd23ee3a972ecc678a75a">vbi_search_status</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Return codes of the vbi_search_next() function. <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="gg32cfe12eb9cbd23ee3a972ecc678a75a644d544ee96768f3e46e4da1dd928d13"></a><!-- doxytag: member="VBI_SEARCH_ERROR" ref="gg32cfe12eb9cbd23ee3a972ecc678a75a644d544ee96768f3e46e4da1dd928d13" args="" -->VBI_SEARCH_ERROR</em> </td><td> Pattern not found, <em>pg</em> is invalid. Another vbi_search_next() will restart from the original starting point. </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg32cfe12eb9cbd23ee3a972ecc678a75a5b44d23d1909bf92a4381b88fe6fdbbf"></a><!-- doxytag: member="VBI_SEARCH_CACHE_EMPTY" ref="gg32cfe12eb9cbd23ee3a972ecc678a75a5b44d23d1909bf92a4381b88fe6fdbbf" args="" -->VBI_SEARCH_CACHE_EMPTY</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 vbi_search_next() continues from this page. </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg32cfe12eb9cbd23ee3a972ecc678a75a7249d87f362cb808eb442498409dc5ba"></a><!-- doxytag: member="VBI_SEARCH_CANCELED" ref="gg32cfe12eb9cbd23ee3a972ecc678a75a7249d87f362cb808eb442498409dc5ba" args="" -->VBI_SEARCH_CANCELED</em> </td><td> No pages in the cache, <em>pg</em> is invalid. </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg32cfe12eb9cbd23ee3a972ecc678a75a73842cc78e2fb97059e2fabf5c6e69de"></a><!-- doxytag: member="VBI_SEARCH_NOT_FOUND" ref="gg32cfe12eb9cbd23ee3a972ecc678a75a73842cc78e2fb97059e2fabf5c6e69de" args="" -->VBI_SEARCH_NOT_FOUND</em> </td><td> Some error occured, condition unclear. Call vbi_search_delete(). </td></tr> <tr><td valign="top"><em><a class="anchor" name="gg32cfe12eb9cbd23ee3a972ecc678a75ad27f98e1ac2798333fb721f0ec58a42c"></a><!-- doxytag: member="VBI_SEARCH_SUCCESS" ref="gg32cfe12eb9cbd23ee3a972ecc678a75ad27f98e1ac2798333fb721f0ec58a42c" args="" -->VBI_SEARCH_SUCCESS</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> </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>