<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Initialize</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.4 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="navrow1" class="tabs"> <ul class="tablist"> <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="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#groups">Modules</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Initialize</div> </div> </div> <div class="contents"> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="groups"></a> Modules</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libquvi__getinfo.html">Session info</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libquvi__release.html">Release</a></td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__libquvi__types.html#ga9a17038aa41a6f1585b541a56a9d4744">QUVIcode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libquvi__init.html#gab05fb31e4bd01cb0a0d544089388c77e">quvi_init</a> (<a class="el" href="group__libquvi__types.html#gabe8d4dbff4b3bf3fc89377c34d0e089b">quvi_t</a> *quvi)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Start a new libquvi session. <a href="#gab05fb31e4bd01cb0a0d544089388c77e"></a><br/></td></tr> </table> <hr/><h2>Function Documentation</h2> <a class="anchor" id="gab05fb31e4bd01cb0a0d544089388c77e"></a><!-- doxytag: member="quvi.h::quvi_init" ref="gab05fb31e4bd01cb0a0d544089388c77e" args="(quvi_t *quvi)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__libquvi__types.html#ga9a17038aa41a6f1585b541a56a9d4744">QUVIcode</a> quvi_init </td> <td>(</td> <td class="paramtype"><a class="el" href="group__libquvi__types.html#gabe8d4dbff4b3bf3fc89377c34d0e089b">quvi_t</a> * </td> <td class="paramname"><em>quvi</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Start a new libquvi session. </p> <p>Initializes a new session handle and locates the website scripts used to parse the page URLs. The library searches the following paths in the following order:</p> <ul> <li>$QUVI_BASEDIR defined path (exclusive, overrides default search paths)</li> <li>Current working directory (./lua/website/)</li> <li>$HOME./quvi/</li> <li>$HOME/.config/quvi/</li> <li>$HOME/.local/share/quvi/</li> <li>--datadir=DIR (and pkgdatadir) specified with configure (script)<ul> <li>These directories are typically $prefix/share/ and $prefix/share/quvi/</li> </ul> </li> </ul> <p>Note that you can have libquvi dump (to stderr) the scanned directory paths by setting the QUVI_SHOW_SCANDIR environment variable.</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">quvi</td><td>Pointer to a new handle</td></tr> </table> </dd> </dl> <dl class="note"><dt><b>Note:</b></dt><dd><ul> <li>Close each created handle with <a class="el" href="group__libquvi__release.html#ga25854269807bc004cf4718053803265e" title="End a libquvi session.">quvi_close()</a> when done using it</li> <li>libcurl will use the http_proxy environment setting if it is set</li> <li>See <a href="http://curl.haxx.se/libcurl/c/curl_easy_setopt.html">http://curl.haxx.se/libcurl/c/curl_easy_setopt.html</a> on how to override that</li> </ul> </dd></dl> <dl class="return"><dt><b>Returns:</b></dt><dd>Non-zero if an error occurred</dd></dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__libquvi__release.html#ga25854269807bc004cf4718053803265e" title="End a libquvi session.">quvi_close</a></dd></dl> <p>Example: </p> <div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <<a class="code" href="quvi_8h.html">quvi/quvi.h</a>></span> ... quvi_t quvi; <span class="keywordtype">int</span> rc; rc = <a class="code" href="group__libquvi__init.html#gab05fb31e4bd01cb0a0d544089388c77e" title="Start a new libquvi session.">quvi_init</a>(&quvi); <span class="keywordflow">if</span> (rc != <a class="code" href="group__libquvi__types.html#gga9a17038aa41a6f1585b541a56a9d4744ad5c802d9e04e5b25f52392b73bed4f24">QUVI_OK</a>) { fprintf(stderr, <span class="stringliteral">"error: libquvi: %s\n"</span>, <a class="code" href="group__libquvi__util.html#gafa9ee07e9a132d0c2fd6d3af941a7c19" title="Return a string describing the error code.">quvi_strerror</a>(quvi,rc)); exit(1); } </pre></div> <dl><dt><b>Examples: </b></dt><dd><a class="el" href="callback_libsoup_8c-example.html#a31">callback_libsoup.c</a>, and <a class="el" href="simple_8c-example.html#a2">simple.c</a>.</dd> </dl> </div> </div> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Thu Aug 18 2011 by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>