You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
672 lines
38 KiB
672 lines
38 KiB
<!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>WORM: WSql::WSqlRecord Class Reference</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.3 -->
|
|
<script type="text/javascript"><!--
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
--></script>
|
|
<script type="text/javascript">
|
|
function hasClass(ele,cls) {
|
|
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
|
|
}
|
|
|
|
function addClass(ele,cls) {
|
|
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
|
|
}
|
|
|
|
function removeClass(ele,cls) {
|
|
if (hasClass(ele,cls)) {
|
|
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
|
|
ele.className=ele.className.replace(reg,' ');
|
|
}
|
|
}
|
|
|
|
function toggleVisibility(linkObj) {
|
|
var base = linkObj.getAttribute('id');
|
|
var summary = document.getElementById(base + '-summary');
|
|
var content = document.getElementById(base + '-content');
|
|
var trigger = document.getElementById(base + '-trigger');
|
|
if ( hasClass(linkObj,'closed') ) {
|
|
summary.style.display = 'none';
|
|
content.style.display = 'block';
|
|
trigger.src = 'open.png';
|
|
removeClass(linkObj,'closed');
|
|
addClass(linkObj,'opened');
|
|
} else if ( hasClass(linkObj,'opened') ) {
|
|
summary.style.display = 'block';
|
|
content.style.display = 'none';
|
|
trigger.src = 'closed.png';
|
|
removeClass(linkObj,'opened');
|
|
addClass(linkObj,'closed');
|
|
}
|
|
return false;
|
|
}
|
|
</script>
|
|
<div id="top">
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="worm_sm.png"></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">WORM <span id="projectnumber">0.2</span></div>
|
|
<div id="projectbrief">A C++ DAL/ORM code generation framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<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="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 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 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="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespace_w_sql.html">WSql</a> </li>
|
|
<li class="navelem"><a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> </li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> </div>
|
|
<div class="headertitle">
|
|
<h1>WSql::WSqlRecord Class Reference</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<!-- doxytag: class="WSql::WSqlRecord" -->
|
|
<p>The <a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> class represents a database record.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>></code></p>
|
|
|
|
<p><a href="class_w_sql_1_1_w_sql_record-members.html">List of all members.</a></p>
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a4716db4931210327d058e0be1092e37b">WSqlRecord</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a328f03b8b380a7336d3f717153dcd75c">WSqlRecord</a> (const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &other)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a6908571d9d3a4305dd791e07dfc2e4eb">operator=</a> (const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &other)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a4d225654e0fb640a88ba0062838d4447">~WSqlRecord</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#afed2c8e2bf71e773610fa57cc574b9a5">operator==</a> (const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &other) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#af14473620be2a96cb69b007edc69903d">operator!=</a> (const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> &other) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a5953463b769a1ccde83f556430e5159d">operator[]</a> (const std::string fieldname) const </td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator to return the data in field <em>fieldname</em> This operator allows for easy access to field data - for example: <a href="#a5953463b769a1ccde83f556430e5159d"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a28154b9bb9dfff22cf4c48f45113d303">operator[]</a> (const char *fieldname) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a85bdf210bc04949c2e1a1c4dc086c87e">append</a> (<a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> field)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#af32612c3e051f7450538cd28c4fc0a2d">at</a> (int pos) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a6b4afb8edabdf5643a56e293f87db609">field</a> (int pos) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a554638cfe7ae6fbe746d92f9562e8754">field</a> (const std::string &colname) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a59a5a0cab9e367cb3f80d7ff69c21584">data</a> (int pos) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a291e3e30f9aadca1dc68478426f2f248">data</a> (const std::string &colname) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#aefebaff2a8ac4f4a0bd25487eca230fb">isNull</a> (int i) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a277d616c522bb856282ef5d1d5ee8978">isNull</a> (const std::string &name) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a36afa7bf1bd9c370b516c417ac7c2afc">indexOf</a> (const std::string &name) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#af61577cabef527cee9c50d14e7472d07">isValid</a> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a2953bb26d9c259a284353aba9cbd33da">empty</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#ab8901f9dda027740e651084084d9e617">size</a> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#aa807dec1b294186d17a550498b5aaf7f">count</a> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">const std::vector< <a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a6359bd78351e9ddb536114117c26890b">fields</a> () const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#ad55c83e8c1652f6acbe8ec077330b690">setNull</a> (int i)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#aa92f468442e5f4b55c8b30122f076431">setNull</a> (const std::string &name)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_w_sql_1_1_w_sql_record.html#a30877cd47a5bd04a02dbbe40a3ae6a55">clear</a> ()</td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><p>The <a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> class represents a database record. </p>
|
|
<p>The <a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> class represents a database record (AKA a "row") returned from a SELECT query as a vector of WSqlFields. <a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> supports adding and removing fields as well as setting and retrieving field names, data values and some metadata.</p>
|
|
<p>The data values of a record's fields can be set by name or position with setData(). To find the position of a field by name use <a class="el" href="class_w_sql_1_1_w_sql_record.html#a36afa7bf1bd9c370b516c417ac7c2afc">indexOf()</a>, and to find the name of a field at a particular position use <a class="el" href="class_w_sql_1_1_w_sql_record.html#af32612c3e051f7450538cd28c4fc0a2d">at()</a>.name() Use <a class="el" href="class_w_sql_1_1_w_sql_record.html#a6b4afb8edabdf5643a56e293f87db609">field()</a> to retrieve a <a class="el" href="class_w_sql_1_1_w_sql_field.html" title="The WSqlField class represents a field in a record.">WSqlField</a> object for a field by name or position. To get a vector of all WSqlFields use <a class="el" href="class_w_sql_1_1_w_sql_record.html#a6359bd78351e9ddb536114117c26890b">fields()</a>.</p>
|
|
<p>There are some convenience operators for getting the data from fields as well - operator[] supports fetching the data from a field by its name: </p>
|
|
<div class="fragment"><pre class="fragment"> std::string fieldname = <span class="stringliteral">"user_name"</span>;
|
|
std::string username = record[fieldname];
|
|
</pre></div><p> This can also be used with plain const char* strings: </p>
|
|
<div class="fragment"><pre class="fragment"> std::string username = record[<span class="stringliteral">"user_name"</span>];
|
|
</pre></div><p>A record can have fields added with <a class="el" href="class_w_sql_1_1_w_sql_record.html#a85bdf210bc04949c2e1a1c4dc086c87e">append()</a> or insert(), replaced with replace(), and removed with remove(). All the fields can be removed with <a class="el" href="class_w_sql_1_1_w_sql_record.html#a30877cd47a5bd04a02dbbe40a3ae6a55">clear()</a>. The number of fields is given by <a class="el" href="class_w_sql_1_1_w_sql_record.html#aa807dec1b294186d17a550498b5aaf7f">count()</a>.</p>
|
|
<p><a class="el" href="class_w_sql_1_1_w_sql_record.html" title="The WSqlRecord class represents a database record.">WSqlRecord</a> is used to populate a <a class="el" href="class_w_sql_1_1_w_sql_result.html" title="The WSqlResult class provides a representation of the result set from a query.">WSqlResult</a> set.</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_w_sql_1_1_w_sql_field.html" title="The WSqlField class represents a field in a record.">WSqlField</a> <a class="el" href="class_w_sql_1_1_w_sql_result.html" title="The WSqlResult class provides a representation of the result set from a query.">WSqlResult</a>. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00030">30</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
</div><hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a4716db4931210327d058e0be1092e37b"></a><!-- doxytag: member="WSql::WSqlRecord::WSqlRecord" ref="a4716db4931210327d058e0be1092e37b" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">WSql::WSqlRecord::WSqlRecord </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00063">63</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a328f03b8b380a7336d3f717153dcd75c"></a><!-- doxytag: member="WSql::WSqlRecord::WSqlRecord" ref="a328f03b8b380a7336d3f717153dcd75c" args="(const WSqlRecord &other)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">WSql::WSqlRecord::WSqlRecord </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00068">68</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4d225654e0fb640a88ba0062838d4447"></a><!-- doxytag: member="WSql::WSqlRecord::~WSqlRecord" ref="a4d225654e0fb640a88ba0062838d4447" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">WSql::WSqlRecord::~WSqlRecord </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000036">Todo:</a></b></dt><dd></dd></dl>
|
|
</p>
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00073">73</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a85bdf210bc04949c2e1a1c4dc086c87e"></a><!-- doxytag: member="WSql::WSqlRecord::append" ref="a85bdf210bc04949c2e1a1c4dc086c87e" args="(WSqlField field)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void WSql::WSqlRecord::append </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> </td>
|
|
<td class="paramname"><em>field</em></td><td>)</td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00043">43</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af32612c3e051f7450538cd28c4fc0a2d"></a><!-- doxytag: member="WSql::WSqlRecord::at" ref="af32612c3e051f7450538cd28c4fc0a2d" args="(int pos) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> WSql::WSqlRecord::at </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>pos</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00145">145</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a30877cd47a5bd04a02dbbe40a3ae6a55"></a><!-- doxytag: member="WSql::WSqlRecord::clear" ref="a30877cd47a5bd04a02dbbe40a3ae6a55" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void WSql::WSqlRecord::clear </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00177">177</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa807dec1b294186d17a550498b5aaf7f"></a><!-- doxytag: member="WSql::WSqlRecord::count" ref="aa807dec1b294186d17a550498b5aaf7f" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int WSql::WSqlRecord::count </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00056">56</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a59a5a0cab9e367cb3f80d7ff69c21584"></a><!-- doxytag: member="WSql::WSqlRecord::data" ref="a59a5a0cab9e367cb3f80d7ff69c21584" args="(int pos) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string WSql::WSqlRecord::data </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>pos</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Returns the value of the field located at position <em>index</em> in the record. If <em>index</em> is out of bounds, an invalid <a class="el" href="class_w_sql_1_1_w_sql_datum.html" title="The WSqlDatum class represents an abstraction of a data element retrieved from a database.">WSqlDatum</a> is returned.</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd>fieldName() <a class="el" href="class_w_sql_1_1_w_sql_record.html#aefebaff2a8ac4f4a0bd25487eca230fb">isNull()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00113">113</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a291e3e30f9aadca1dc68478426f2f248"></a><!-- doxytag: member="WSql::WSqlRecord::data" ref="a291e3e30f9aadca1dc68478426f2f248" args="(const std::string &colname) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string WSql::WSqlRecord::data </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>colname</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Returns the value of the field called <em>name</em> in the record. If field <em>name</em> does not exist an invalid <a class="el" href="class_w_sql_1_1_w_sql_datum.html" title="The WSqlDatum class represents an abstraction of a data element retrieved from a database.">WSqlDatum</a> is returned.</p>
|
|
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_w_sql_1_1_w_sql_record.html#a36afa7bf1bd9c370b516c417ac7c2afc">indexOf()</a> </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00126">126</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2953bb26d9c259a284353aba9cbd33da"></a><!-- doxytag: member="WSql::WSqlRecord::empty" ref="a2953bb26d9c259a284353aba9cbd33da" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool WSql::WSqlRecord::empty </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td><code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00054">54</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a554638cfe7ae6fbe746d92f9562e8754"></a><!-- doxytag: member="WSql::WSqlRecord::field" ref="a554638cfe7ae6fbe746d92f9562e8754" args="(const std::string &colname) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> WSql::WSqlRecord::field </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>colname</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00153">153</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6b4afb8edabdf5643a56e293f87db609"></a><!-- doxytag: member="WSql::WSqlRecord::field" ref="a6b4afb8edabdf5643a56e293f87db609" args="(int pos) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a> WSql::WSqlRecord::field </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>pos</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00140">140</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6359bd78351e9ddb536114117c26890b"></a><!-- doxytag: member="WSql::WSqlRecord::fields" ref="a6359bd78351e9ddb536114117c26890b" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector<<a class="el" href="class_w_sql_1_1_w_sql_field.html">WSqlField</a>>& WSql::WSqlRecord::fields </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000038">Todo:</a></b></dt><dd>THIS maybe should be const std::vector<WSqlField *>& <a class="el" href="class_w_sql_1_1_w_sql_record.html#a6359bd78351e9ddb536114117c26890b">fields() const </a>{return _fields;}; </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00060">60</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a36afa7bf1bd9c370b516c417ac7c2afc"></a><!-- doxytag: member="WSql::WSqlRecord::indexOf" ref="a36afa7bf1bd9c370b516c417ac7c2afc" args="(const std::string &name) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int WSql::WSqlRecord::indexOf </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00158">158</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a277d616c522bb856282ef5d1d5ee8978"></a><!-- doxytag: member="WSql::WSqlRecord::isNull" ref="a277d616c522bb856282ef5d1d5ee8978" args="(const std::string &name) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool WSql::WSqlRecord::isNull </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00131">131</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aefebaff2a8ac4f4a0bd25487eca230fb"></a><!-- doxytag: member="WSql::WSqlRecord::isNull" ref="aefebaff2a8ac4f4a0bd25487eca230fb" args="(int i) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool WSql::WSqlRecord::isNull </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>i</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00135">135</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af61577cabef527cee9c50d14e7472d07"></a><!-- doxytag: member="WSql::WSqlRecord::isValid" ref="af61577cabef527cee9c50d14e7472d07" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool WSql::WSqlRecord::isValid </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00053">53</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af14473620be2a96cb69b007edc69903d"></a><!-- doxytag: member="WSql::WSqlRecord::operator!=" ref="af14473620be2a96cb69b007edc69903d" args="(const WSqlRecord &other) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool WSql::WSqlRecord::operator!= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00039">39</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6908571d9d3a4305dd791e07dfc2e4eb"></a><!-- doxytag: member="WSql::WSqlRecord::operator=" ref="a6908571d9d3a4305dd791e07dfc2e4eb" args="(const WSqlRecord &other)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> & WSql::WSqlRecord::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00078">78</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afed2c8e2bf71e773610fa57cc574b9a5"></a><!-- doxytag: member="WSql::WSqlRecord::operator==" ref="afed2c8e2bf71e773610fa57cc574b9a5" args="(const WSqlRecord &other) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool WSql::WSqlRecord::operator== </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_w_sql_1_1_w_sql_record.html">WSqlRecord</a> & </td>
|
|
<td class="paramname"><em>other</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000037">Todo:</a></b></dt><dd></dd></dl>
|
|
</p>
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00084">84</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5953463b769a1ccde83f556430e5159d"></a><!-- doxytag: member="WSql::WSqlRecord::operator[]" ref="a5953463b769a1ccde83f556430e5159d" args="(const std::string fieldname) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string WSql::WSqlRecord::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string </td>
|
|
<td class="paramname"><em>fieldname</em></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Operator to return the data in field <em>fieldname</em> This operator allows for easy access to field data - for example: </p>
|
|
<div class="fragment"><pre class="fragment"> std::string username = record[std::string(<span class="stringliteral">"user_name"</span>)];
|
|
</pre></div>
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00040">40</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a28154b9bb9dfff22cf4c48f45113d303"></a><!-- doxytag: member="WSql::WSqlRecord::operator[]" ref="a28154b9bb9dfff22cf4c48f45113d303" args="(const char *fieldname) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string WSql::WSqlRecord::operator[] </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>fieldname</em></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00041">41</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa92f468442e5f4b55c8b30122f076431"></a><!-- doxytag: member="WSql::WSqlRecord::setNull" ref="aa92f468442e5f4b55c8b30122f076431" args="(const std::string &name)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void WSql::WSqlRecord::setNull </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00089">89</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad55c83e8c1652f6acbe8ec077330b690"></a><!-- doxytag: member="WSql::WSqlRecord::setNull" ref="ad55c83e8c1652f6acbe8ec077330b690" args="(int i)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void WSql::WSqlRecord::setNull </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>i</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000039">Todo:</a></b></dt><dd>template <typename t>=""> void setData( T t, int pos ) { </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8cpp_source.html#l00093">93</a> of file <a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab8901f9dda027740e651084084d9e617"></a><!-- doxytag: member="WSql::WSqlRecord::size" ref="ab8901f9dda027740e651084084d9e617" args="() const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int WSql::WSqlRecord::size </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [inline]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="wsqlrecord_8h_source.html#l00055">55</a> of file <a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/sql/<a class="el" href="wsqlrecord_8h_source.html">wsqlrecord.h</a></li>
|
|
<li>src/sql/<a class="el" href="wsqlrecord_8cpp_source.html">wsqlrecord.cpp</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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<hr class="footer"/><address class="footer"><small>Generated on Fri Nov 18 2011 21:01:46 for WORM by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
|
|
</body>
|
|
</html>
|