<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>VSQLite++: sqlite::connection Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">VSQLite++
 <span id="projectnumber">0.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</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>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</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>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesqlite.html">sqlite</a></li><li class="navelem"><a class="el" href="structsqlite_1_1connection.html">connection</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="#friends">Friends</a> |
<a href="structsqlite_1_1connection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sqlite::connection Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>connection is used to open, close, attach and detach a database. Further it has to be passed to all classes since it represents the connection to the database and contains the internal needed handle, so you can see a connection object as handle to the database An object of this class is not copyable
<a href="structsqlite_1_1connection.html#details">More...</a></p>
<p><code>#include <<a class="el" href="connection_8hpp_source.html">connection.hpp</a>></code></p>
<div class="dynheader">
Inheritance diagram for sqlite::connection:</div>
<div class="dyncontent">
<div class="center"><img src="structsqlite_1_1connection__inherit__graph.png" border="0" usemap="#sqlite_1_1connection_inherit__map" alt="Inheritance graph"/></div>
<map name="sqlite_1_1connection_inherit__map" id="sqlite_1_1connection_inherit__map">
</map>
</div>
<div class="dynheader">
Collaboration diagram for sqlite::connection:</div>
<div class="dyncontent">
<div class="center"><img src="structsqlite_1_1connection__coll__graph.png" border="0" usemap="#sqlite_1_1connection_coll__map" alt="Collaboration graph"/></div>
<map name="sqlite_1_1connection_coll__map" id="sqlite_1_1connection_coll__map">
</map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acc76e93f9d24e0b270f39a9814c7766d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsqlite_1_1connection.html#acc76e93f9d24e0b270f39a9814c7766d">connection</a> (std::string const &db)</td></tr>
<tr class="memdesc:acc76e93f9d24e0b270f39a9814c7766d"><td class="mdescLeft"> </td><td class="mdescRight">constructor opens the database <a href="#acc76e93f9d24e0b270f39a9814c7766d">More...</a><br /></td></tr>
<tr class="separator:acc76e93f9d24e0b270f39a9814c7766d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae283598f09765b48dea026b93c43d4c4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structsqlite_1_1connection.html#ae283598f09765b48dea026b93c43d4c4">~connection</a> ()</td></tr>
<tr class="memdesc:ae283598f09765b48dea026b93c43d4c4"><td class="mdescLeft"> </td><td class="mdescRight">destructor closes the database automatically <a href="#ae283598f09765b48dea026b93c43d4c4">More...</a><br /></td></tr>
<tr class="separator:ae283598f09765b48dea026b93c43d4c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a134ee0ccce14979cc0cc732ca6e1888a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsqlite_1_1connection.html#a134ee0ccce14979cc0cc732ca6e1888a">attach</a> (std::string const &db, std::string const &database_alias)</td></tr>
<tr class="memdesc:a134ee0ccce14979cc0cc732ca6e1888a"><td class="mdescLeft"> </td><td class="mdescRight">attaches another database file to the database represented by the object of this class. It is possible to attach up to 10 times the same database file with different aliases <a href="#a134ee0ccce14979cc0cc732ca6e1888a">More...</a><br /></td></tr>
<tr class="separator:a134ee0ccce14979cc0cc732ca6e1888a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70c6b8f37146b2266cc289b0cfcfcd7a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsqlite_1_1connection.html#a70c6b8f37146b2266cc289b0cfcfcd7a">detach</a> (std::string const &database_alias)</td></tr>
<tr class="memdesc:a70c6b8f37146b2266cc289b0cfcfcd7a"><td class="mdescLeft"> </td><td class="mdescRight">detaches a database via alias, if the same database was attached with several names they will be still present <a href="#a70c6b8f37146b2266cc289b0cfcfcd7a">More...</a><br /></td></tr>
<tr class="separator:a70c6b8f37146b2266cc289b0cfcfcd7a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:af09578e15de52d1942f548cb6e5ab151"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsqlite_1_1connection.html#af09578e15de52d1942f548cb6e5ab151">open</a> (std::string const &db)</td></tr>
<tr class="separator:af09578e15de52d1942f548cb6e5ab151"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afda74995f569a16f2e421473ce957f0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsqlite_1_1connection.html#afda74995f569a16f2e421473ce957f0f">close</a> ()</td></tr>
<tr class="separator:afda74995f569a16f2e421473ce957f0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28c376db706da7842ee3600c2634c027"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structsqlite_1_1connection.html#a28c376db706da7842ee3600c2634c027">access_check</a> ()</td></tr>
<tr class="separator:a28c376db706da7842ee3600c2634c027"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:af6f210ec001c6b9be2c28937f84e5b8e"><td class="memItemLeft" align="right" valign="top">sqlite3 * </td><td class="memItemRight" valign="bottom"><a class="el" href="structsqlite_1_1connection.html#af6f210ec001c6b9be2c28937f84e5b8e">handle</a></td></tr>
<tr class="separator:af6f210ec001c6b9be2c28937f84e5b8e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a8daf12b49848f86f262e288a0a9eb3d4"><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structsqlite_1_1connection.html#a8daf12b49848f86f262e288a0a9eb3d4">private_accessor</a></td></tr>
<tr class="separator:a8daf12b49848f86f262e288a0a9eb3d4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>connection is used to open, close, attach and detach a database. Further it has to be passed to all classes since it represents the connection to the database and contains the internal needed handle, so you can see a connection object as handle to the database An object of this class is not copyable </p>
<p>Definition at line <a class="el" href="connection_8hpp_source.html#l00045">45</a> of file <a class="el" href="connection_8hpp_source.html">connection.hpp</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="acc76e93f9d24e0b270f39a9814c7766d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sqlite::connection::connection </td>
<td>(</td>
<td class="paramtype">std::string const & </td>
<td class="paramname"><em>db</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>constructor opens the database </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">db</td><td>filename of the database file if the given file already exists the file will be opened as database. If the file does not exist a new database will be created </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae283598f09765b48dea026b93c43d4c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sqlite::connection::~connection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destructor closes the database automatically </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a28c376db706da7842ee3600c2634c027"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sqlite::connection::access_check </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Referenced by <a class="el" href="private__accessor_8hpp_source.html#l00045">sqlite::private_accessor::acccess_check()</a>.</p>
</div>
</div>
<a class="anchor" id="a134ee0ccce14979cc0cc732ca6e1888a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sqlite::connection::attach </td>
<td>(</td>
<td class="paramtype">std::string const & </td>
<td class="paramname"><em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string const & </td>
<td class="paramname"><em>database_alias</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>attaches another database file to the database represented by the object of this class. It is possible to attach up to 10 times the same database file with different aliases </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">db</td><td>database filename of the database should be attached </td></tr>
<tr><td class="paramname">database_alias</td><td>alias which should be used </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="afda74995f569a16f2e421473ce957f0f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sqlite::connection::close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a70c6b8f37146b2266cc289b0cfcfcd7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sqlite::connection::detach </td>
<td>(</td>
<td class="paramtype">std::string const & </td>
<td class="paramname"><em>database_alias</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>detaches a database via alias, if the same database was attached with several names they will be still present </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">database_alias</td><td>of the database (must be the same alias which was passed in the <a class="el" href="structsqlite_1_1connection.html#a134ee0ccce14979cc0cc732ca6e1888a" title="attaches another database file to the database represented by the object of this class. It is possible to attach up to 10 times the same database file with different aliases ">attach()</a> call) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af09578e15de52d1942f548cb6e5ab151"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void sqlite::connection::open </td>
<td>(</td>
<td class="paramtype">std::string const & </td>
<td class="paramname"><em>db</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a8daf12b49848f86f262e288a0a9eb3d4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend struct <a class="el" href="structsqlite_1_1private__accessor.html">private_accessor</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="connection_8hpp_source.html#l00074">74</a> of file <a class="el" href="connection_8hpp_source.html">connection.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="af6f210ec001c6b9be2c28937f84e5b8e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sqlite3* sqlite::connection::handle</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="connection_8hpp_source.html#l00080">80</a> of file <a class="el" href="connection_8hpp_source.html">connection.hpp</a>.</p>
<p>Referenced by <a class="el" href="private__accessor_8hpp_source.html#l00042">sqlite::private_accessor::get_handle()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/sqlite/<a class="el" href="connection_8hpp_source.html">connection.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Oct 31 2014 11:19:54 for VSQLite++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
37580327e17dbd29f07260d361df35e7
>
files
>
331
