<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>Xapian: API Documentation: xapian-core: Xapian::Auto Namespace Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head> <body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.5.9 --> <script type="text/javascript"> <!-- function changeDisplayState (e){ var num=this.id.replace(/[^[0-9]/g,''); var button=this.firstChild; var sectionDiv=document.getElementById('dynsection'+num); if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){ sectionDiv.style.display='block'; button.src='open.gif'; }else{ sectionDiv.style.display='none'; button.src='closed.gif'; } } function initDynSections(){ var divs=document.getElementsByTagName('div'); var sectionCounter=1; for(var i=0;i<divs.length-1;i++){ if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){ var header=divs[i]; var section=divs[i+1]; var button=header.firstChild; if (button!='IMG'){ divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild); button=document.createElement('img'); divs[i].insertBefore(button,divs[i].firstChild); } header.style.cursor='pointer'; header.onclick=changeDisplayState; header.id='dynheader'+sectionCounter; button.src='closed.gif'; section.id='dynsection'+sectionCounter; section.style.display='none'; section.style.marginLeft='14px'; sectionCounter++; } } } window.onload = initDynSections; --> </script> <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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="namespaces.html"><span>Namespace List</span></a></li> <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="namespaceXapian_1_1Auto.html">Auto</a> </div> </div> <div class="contents"> <h1>Xapian::Auto Namespace Reference</h1><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions which determine the database type automatically. <a href="#_details">More...</a> <p> <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"><a class="el" href="classXapian_1_1Database.html">Database</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Auto.html#061dd41e3c877bf094251d25975fe3ee">open_stub</a> (const std::string &file)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object for a stub database file. <a href="#061dd41e3c877bf094251d25975fe3ee"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Auto.html#299894005d7f0996d113d87da285ea8c">open_stub</a> (const std::string &file, int action)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database.">WritableDatabase</a> object for a stub database file. <a href="#299894005d7f0996d113d87da285ea8c"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions which determine the database type automatically. <p> <hr><h2>Function Documentation</h2> <a class="anchor" name="299894005d7f0996d113d87da285ea8c"></a><!-- doxytag: member="Xapian::Auto::open_stub" ref="299894005d7f0996d113d87da285ea8c" args="(const std::string &file, int action)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> Xapian::Auto::open_stub </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>action</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> Construct a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database.">WritableDatabase</a> object for a stub database file. <p> The stub database file must contain serialised parameters for exactly one database.<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>file</em> </td><td>pathname of the stub database file. </td></tr> <tr><td valign="top"></td><td valign="top"><em>action</em> </td><td>determines handling of existing/non-existing database:<ul> <li><a class="el" href="namespaceXapian.html#1236aaa6a3d7a37a4c6b95439e449f7a" title="Create a new database; fail if db exists.">Xapian::DB_CREATE</a> fail if database already exist, otherwise create new database.</li><li><a class="el" href="namespaceXapian.html#3d32111900603ce02b8c8467b9c5bacb" title="Open for read/write; create if no db exists.">Xapian::DB_CREATE_OR_OPEN</a> open existing database, or create new database if none exists.</li><li><a class="el" href="namespaceXapian.html#fbc13e6712a12dcfd0c048242fc313ed" title="Overwrite existing db; create if none exists.">Xapian::DB_CREATE_OR_OVERWRITE</a> overwrite existing database, or create new database if none exists.</li><li><a class="el" href="namespaceXapian.html#54521467b649894bdc411f4c35e56ac3" title="Open for read/write; fail if no db exists.">Xapian::DB_OPEN</a> open existing database, failing if none exists. </li></ul> </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="061dd41e3c877bf094251d25975fe3ee"></a><!-- doxytag: member="Xapian::Auto::open_stub" ref="061dd41e3c877bf094251d25975fe3ee" args="(const std::string &file)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classXapian_1_1Database.html">Database</a> Xapian::Auto::open_stub </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>file</em> </td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p> Construct a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object for a stub database file. <p> The stub database file contains serialised parameters for one or more databases.<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>file</em> </td><td>pathname of the stub database file. </td></tr> </table> </dl> </div> </div><p> </div> <hr> <address><small> Documentation for Xapian (version 1.2.12).<br> Generated on 27 Jun 2012 by <a href="http://www.doxygen.org/">Doxygen 1.5.9</a>. </small></address> </body> </html>