<?xml version="1.0" encoding="UTF-8"?>
<!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" lang="en_US" xml:lang="en_US">
<head>
<title>kpilot/lib: PilotDatabase Class Reference (kpilot/lib)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
<style type="text/css">
<!--
hr { display: none; }
#content h2 { margin-left: 0px; }
table.mdTable { background-color: #f8f8f8; border: .2em solid #d7d7d7; }
td.mdRow { padding: 8px 20px; }
td.md { font-weight: bold; }
td.mdname1 { font-weight: bold; color: #602020; }
td.mdname { font-weight: bold; color: #602020; }
-->
</style>
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../../.."><img id="nav_header_logo" alt="Home" align="left" src="../../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<img id="nav_header_logo_right" alt="" align="right" src="../../../pimlogo.png" border="0" />
<div id="nav_header_title" align="left">KDE PIM API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_left" style="text-align: left;">
/ <a href="../../../">API Reference</a>
/ <a href="../../html/index.html">kpilot</a> / <a href=".">lib</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<h2><a name="content"></a>kpilot/lib</h2>
<!-- Generated by Doxygen 1.5.5 -->
<div class="contents">
<h1>PilotDatabase Class Reference</h1><!-- doxytag: class="PilotDatabase" --><code>#include <<a class="el" href="pilotDatabase_8h-source.html">pilotDatabase.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for PilotDatabase:</div>
<div class="dynsection">
<p><center><img src="classPilotDatabase.png" usemap="#PilotDatabase_map" border="0" alt=""></center>
<map name="PilotDatabase_map">
<area href="classPilotLocalDatabase.html" alt="PilotLocalDatabase" shape="rect" coords="0,56,122,80">
<area href="classPilotSerialDatabase.html" alt="PilotSerialDatabase" shape="rect" coords="132,56,254,80">
</map>
</div>
<p>
<a href="classPilotDatabase-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Methods to access a database on the pilot.
<p>
NOTE: It is the users responsibility to delete PilotRecords returned by <a class="el" href="classPilotDatabase.html" title="Methods to access a database on the pilot.">PilotDatabase</a> methods when finished with them!
<p>Definition at line <a class="el" href="pilotDatabase_8h-source.html#l00050">50</a> of file <a class="el" href="pilotDatabase_8h-source.html">pilotDatabase.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#f5ccab01d90d0becc7116093be174647">DBType</a> { <b>eNone</b> = 0,
<b>eLocalDB</b> = 1,
<b>eSerialDB</b> = 2
}</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="332ae5c8a8573d0b09570cdec799fbef"></a><!-- doxytag: member="PilotDatabase::PilotDatabase" ref="332ae5c8a8573d0b09570cdec799fbef" args="(const QString &name=QString::null)" -->
</td><td class="memItemRight" valign="bottom"><b>PilotDatabase</b> (const QString &name=QString::null)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c94f8377b0c17f75e416dc413096522f"></a><!-- doxytag: member="PilotDatabase::name" ref="c94f8377b0c17f75e416dc413096522f" args="() const " -->
QString </td><td class="memItemRight" valign="bottom"><b>name</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#d1698d12ca266a8306e5bc34df5e560c">createDatabase</a> (long creator=0, long type=0, int cardno=0, int flags=0, int version=0)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#7ca916f83f35fddaca5a2317e7a09d28">deleteDatabase</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#8c8ba52882f589437a7b3f7d016bdc1b">readAppBlock</a> (unsigned char *buffer, int maxLen)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#1404eedc672242ed7e9760abf40419b2">writeAppBlock</a> (unsigned char *buffer, int len)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#cdca85cac6283e67eb638c0482d0264d">recordCount</a> () const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Pilot::RecordIDList </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#14470b7fcd6e6ecc6b1349709f122533">idList</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual Pilot::RecordIDList </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#0fbcca5afb6abd1213e09093c1b3737c">modifiedIDList</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPilotRecord.html">PilotRecord</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#4de980c912281991628b51f10c3afa52">readRecordById</a> (recordid_t id)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPilotRecord.html">PilotRecord</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#eaadc91b9377769c34527474812ed49f">readRecordByIndex</a> (int index)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPilotRecord.html">PilotRecord</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#fceb792665a47405cab20a4a834e7078">readNextRecInCategory</a> (int category)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPilotRecord.html">PilotRecord</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#f964f36b35ba4d13917408e4813d599a">readNextModifiedRec</a> (int *ind=NULL)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual recordid_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#974c3b97cfb107386929c108a67def14">writeRecord</a> (<a class="el" href="classPilotRecord.html">PilotRecord</a> *newRecord)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#e7e2e329de660b00b202af22e7e6f992">deleteRecord</a> (recordid_t id, bool all=false)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#9543bcac4220b5356bcd238435b3c68a">resetSyncFlags</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#033b9c7d48e633bab3281351820cf293">resetDBIndex</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#cb57840cbb710cb4788296b0a938e0cf">cleanup</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6df33d3d8089be105fe0dca6b3baa277"></a><!-- doxytag: member="PilotDatabase::isOpen" ref="6df33d3d8089be105fe0dca6b3baa277" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><b>isOpen</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#e4f502da20c819cc7527ab1ad1f3b2ab">dbPathName</a> () const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5a57d6ca2119690355f62dd5e3a8cda"></a><!-- doxytag: member="PilotDatabase::dbType" ref="d5a57d6ca2119690355f62dd5e3a8cda" args="() const =0" -->
virtual <a class="el" href="classPilotDatabase.html#f5ccab01d90d0becc7116093be174647">DBType</a> </td><td class="memItemRight" valign="bottom"><b>dbType</b> () const =0</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPilotDatabase.html#de8ff233bbdb22a5012475e79e6d710a">instanceCount</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9109525d79d4fc705626ecaa5a2baf2e"></a><!-- doxytag: member="PilotDatabase::isResource" ref="9109525d79d4fc705626ecaa5a2baf2e" args="(struct DBInfo *info)" -->
static bool </td><td class="memItemRight" valign="bottom"><b>isResource</b> (struct DBInfo *info)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="414490a38ef65caa92a447e3e07074b3"></a><!-- doxytag: member="PilotDatabase::openDatabase" ref="414490a38ef65caa92a447e3e07074b3" args="()=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>openDatabase</b> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0d69976a3a9135f7e32a0aaf9863115d"></a><!-- doxytag: member="PilotDatabase::closeDatabase" ref="0d69976a3a9135f7e32a0aaf9863115d" args="()=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>closeDatabase</b> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="33ffff37d6ef39ee2b97803ae0db5b6a"></a><!-- doxytag: member="PilotDatabase::setDBOpen" ref="33ffff37d6ef39ee2b97803ae0db5b6a" args="(bool yesno)" -->
void </td><td class="memItemRight" valign="bottom"><b>setDBOpen</b> (bool yesno)</td></tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="f5ccab01d90d0becc7116093be174647"></a><!-- doxytag: member="PilotDatabase::DBType" ref="f5ccab01d90d0becc7116093be174647" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classPilotDatabase.html#f5ccab01d90d0becc7116093be174647">PilotDatabase::DBType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Use this instead of RTTI to determine the type of a <a class="el" href="classPilotDatabase.html" title="Methods to access a database on the pilot.">PilotDatabase</a>, for those cases where it's important.
<p>
<p>Definition at line <a class="el" href="pilotDatabase_8h-source.html#l00155">155</a> of file <a class="el" href="pilotDatabase_8h-source.html">pilotDatabase.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="de8ff233bbdb22a5012475e79e6d710a"></a><!-- doxytag: member="PilotDatabase::instanceCount" ref="de8ff233bbdb22a5012475e79e6d710a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PilotDatabase::instanceCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Debugging information: tally how many databases are created or destroyed.
<p>
Returns the count of currently existing databases.
<p>Definition at line <a class="el" href="pilotDatabase_8cc-source.html#l00070">70</a> of file <a class="el" href="pilotDatabase_8cc-source.html">pilotDatabase.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="d1698d12ca266a8306e5bc34df5e560c"></a><!-- doxytag: member="PilotDatabase::createDatabase" ref="d1698d12ca266a8306e5bc34df5e560c" args="(long creator=0, long type=0, int cardno=0, int flags=0, int version=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool PilotDatabase::createDatabase </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"> <em>creator</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>type</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>cardno</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>flags</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>version</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates the database with the given creator, type and flags on the given card (default is RAM).
<p>
If the database already exists, this function does nothing.
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#7105edecba735d9aa2d503358c9e8149">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#82b4591a0aa2ade0bb528c14dc5159bc">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="7ca916f83f35fddaca5a2317e7a09d28"></a><!-- doxytag: member="PilotDatabase::deleteDatabase" ref="7ca916f83f35fddaca5a2317e7a09d28" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int PilotDatabase::deleteDatabase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Deletes the database (by name, as given in the constructor, the database name is stored depending on the implementation of <a class="el" href="classPilotLocalDatabase.html" title="PilotLocalDatabase represents databases in the same binary format as on the handheld...">PilotLocalDatabase</a> and PilotSerialDatabas).
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#3dafde5dda8e12bebd07e9e28280b9ac">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#8f6dd0cadfd106fa86ee65e5c6bada68">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="8c8ba52882f589437a7b3f7d016bdc1b"></a><!-- doxytag: member="PilotDatabase::readAppBlock" ref="8c8ba52882f589437a7b3f7d016bdc1b" args="(unsigned char *buffer, int maxLen)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int PilotDatabase::readAppBlock </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>maxLen</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads the application block info, returns size.
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#3976df79e42d5b56c5a2d28b7671a15d">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#e8d3d51adde43ea47e471738dffd4285">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="1404eedc672242ed7e9760abf40419b2"></a><!-- doxytag: member="PilotDatabase::writeAppBlock" ref="1404eedc672242ed7e9760abf40419b2" args="(unsigned char *buffer, int len)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int PilotDatabase::writeAppBlock </td>
<td>(</td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"> <em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Writes the application block info.
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#2b3716d56fae974ba5fc04786d8c28b9">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#adec0b2aafed061054dd226b16d3a737">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="cdca85cac6283e67eb638c0482d0264d"></a><!-- doxytag: member="PilotDatabase::recordCount" ref="cdca85cac6283e67eb638c0482d0264d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int PilotDatabase::recordCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the number of records in the database.
<p>
If the database is not open, return -1.
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#7a3721e65a357d9c5186c2c96d50d229">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#9cb91d6d21e1720d64f82dcc8fe97302">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="14470b7fcd6e6ecc6b1349709f122533"></a><!-- doxytag: member="PilotDatabase::idList" ref="14470b7fcd6e6ecc6b1349709f122533" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Pilot::RecordIDList PilotDatabase::idList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a QValueList of all record ids in the database.
<p>
This implementation is really bad.
<p>Reimplemented in <a class="el" href="classPilotLocalDatabase.html#bcefc77a00b291fef857928cf2ddb7bc">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#2815facb01b40d92f86e5008283f83ab">PilotSerialDatabase</a>.</p>
<p>Definition at line <a class="el" href="pilotDatabase_8cc-source.html#l00082">82</a> of file <a class="el" href="pilotDatabase_8cc-source.html">pilotDatabase.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="0fbcca5afb6abd1213e09093c1b3737c"></a><!-- doxytag: member="PilotDatabase::modifiedIDList" ref="0fbcca5afb6abd1213e09093c1b3737c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Pilot::RecordIDList PilotDatabase::modifiedIDList </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a list of all record ids that have been modified in the database.
<p>
This implementation is really bad.
<p>Definition at line <a class="el" href="pilotDatabase_8cc-source.html#l00097">97</a> of file <a class="el" href="pilotDatabase_8cc-source.html">pilotDatabase.cc</a>.</p>
</div>
</div><p>
<a class="anchor" name="4de980c912281991628b51f10c3afa52"></a><!-- doxytag: member="PilotDatabase::readRecordById" ref="4de980c912281991628b51f10c3afa52" args="(recordid_t id)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPilotRecord.html">PilotRecord</a>* PilotDatabase::readRecordById </td>
<td>(</td>
<td class="paramtype">recordid_t </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads a record from database by id, returns record length.
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#3fe06fdf1d80a2e3cacbdfb172f413bf">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#e7074bfdf1874f8d1994534232174d98">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="eaadc91b9377769c34527474812ed49f"></a><!-- doxytag: member="PilotDatabase::readRecordByIndex" ref="eaadc91b9377769c34527474812ed49f" args="(int index)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPilotRecord.html">PilotRecord</a>* PilotDatabase::readRecordByIndex </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads a record from database, returns the record length.
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#fe928227f0e370aeac69d2c252c3a8c0">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#bd3a9658387f8e1dab4cd0f4031eaa99">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="fceb792665a47405cab20a4a834e7078"></a><!-- doxytag: member="PilotDatabase::readNextRecInCategory" ref="fceb792665a47405cab20a4a834e7078" args="(int category)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPilotRecord.html">PilotRecord</a>* PilotDatabase::readNextRecInCategory </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>category</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads the next record from database in category 'category'.
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#dd30689a7e39bd5decd5a461a769b6a7">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#df8b459a9bf60f69e7b6c0aaaa7dd2d3">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="f964f36b35ba4d13917408e4813d599a"></a><!-- doxytag: member="PilotDatabase::readNextModifiedRec" ref="f964f36b35ba4d13917408e4813d599a" args="(int *ind=NULL)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classPilotRecord.html">PilotRecord</a>* PilotDatabase::readNextModifiedRec </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>ind</em> = <code>NULL</code> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reads the next record from database that has the dirty flag set.
<p>
If <code>ind</code> is non-NULL, *ind is set to the index of the current record (i.e. before the record pointer moves to the next modified record).
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#2e149236200833a1e60721aa4bed15ad">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#5d63ffc287a43e834eaf64419673b80f">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="974c3b97cfb107386929c108a67def14"></a><!-- doxytag: member="PilotDatabase::writeRecord" ref="974c3b97cfb107386929c108a67def14" args="(PilotRecord *newRecord)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual recordid_t PilotDatabase::writeRecord </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPilotRecord.html">PilotRecord</a> * </td>
<td class="paramname"> <em>newRecord</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Writes a new record to database (if 'id' == 0, one will be assigned to newRecord).
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#172791a7b8d3525a9b59f84f8408cd83">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#900630953e2a83d0869b4932f4658e53">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="e7e2e329de660b00b202af22e7e6f992"></a><!-- doxytag: member="PilotDatabase::deleteRecord" ref="e7e2e329de660b00b202af22e7e6f992" args="(recordid_t id, bool all=false)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int PilotDatabase::deleteRecord </td>
<td>(</td>
<td class="paramtype">recordid_t </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>all</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Deletes a record with the given recordid_t from the database, or all records, if <code>all</code> is set to true.
<p>
The recordid_t will be ignored in this case.<p>
Return value is negative on error, 0 otherwise.
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#c08f19243207f7da3561621f16c757ab">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#4b6f498e6b21e1086c17238cd50bacc9">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="9543bcac4220b5356bcd238435b3c68a"></a><!-- doxytag: member="PilotDatabase::resetSyncFlags" ref="9543bcac4220b5356bcd238435b3c68a" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int PilotDatabase::resetSyncFlags </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resets all records in the database to not dirty.
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#e8bdab2bfd237e19477bafd5008f09a8">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#b91b4e8bff4d80c2ec2018dfac4c969e">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="033b9c7d48e633bab3281351820cf293"></a><!-- doxytag: member="PilotDatabase::resetDBIndex" ref="033b9c7d48e633bab3281351820cf293" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int PilotDatabase::resetDBIndex </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Resets next record index to beginning.
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#2688684d7e268d83742fb73339d1646b">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#47a606f47cf0781dfb58aa095351dcd3">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="cb57840cbb710cb4788296b0a938e0cf"></a><!-- doxytag: member="PilotDatabase::cleanup" ref="cb57840cbb710cb4788296b0a938e0cf" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int PilotDatabase::cleanup </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Purges all Archived/Deleted records from Palm <a class="el" href="namespacePilot.html" title="The Pilot namespace holds constants that are global for the handheld data structures...">Pilot</a> database.
<p>
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#2e7239da8c72258dc7be3e23b5dcdf96">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#dec9667de0f9d0935cc1d95dbb2cd51c">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<a class="anchor" name="e4f502da20c819cc7527ab1ad1f3b2ab"></a><!-- doxytag: member="PilotDatabase::dbPathName" ref="e4f502da20c819cc7527ab1ad1f3b2ab" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual QString PilotDatabase::dbPathName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns some sensible human-readable identifier for the database.
<p>
Serial databases get <a class="el" href="namespacePilot.html" title="The Pilot namespace holds constants that are global for the handheld data structures...">Pilot</a>:, local databases return the full path.
<p>Implemented in <a class="el" href="classPilotLocalDatabase.html#eed119737e1d2c62bbe9fb7814d2ba86">PilotLocalDatabase</a>, and <a class="el" href="classPilotSerialDatabase.html#ce43d59e5f0e30257940b76d27bc6b64">PilotSerialDatabase</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="pilotDatabase_8h-source.html">pilotDatabase.h</a><li><a class="el" href="pilotDatabase_8cc-source.html">pilotDatabase.cc</a></ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kpilot/lib</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classActionQueue.html">actionqueue</option>, <option value="classCleanupAction.html">cleanupaction</option>, <option value="classConduitAction.html">conduitaction</option>, <option value="classConduitConfigBase.html">conduitconfigbase</option>, <option value="classConduitFactory.html">conduitfactory</option>, <option value="classConduitProxy.html">conduitproxy</option>, <option value="classCUDCounter.html">cudcounter</option>, <option value="classDatabaseInterpreter.html">databaseinterpreter</option>, <option value="classDeviceCommThread.html">devicecommthread</option>, <option value="classIDMapper.html">idmapper</option>, <option value="classKPilotDeviceLink.html">kpilotdevicelink</option>, <option value="classKPilotLink.html">kpilotlink</option>, <option value="classKPilotLocalLink.html">kpilotlocallink</option>, <option value="classNullMapper.html">nullmapper</option>, <option value="classPhoneSlot.html">phoneslot</option>, <option value="classPilotAddress.html">pilotaddress</option>, <option value="classPilotAppInfo.html">pilotappinfo</option>, <option value="classPilotAppInfoBase.html">pilotappinfobase</option>, <option value="classPilotDatabase.html">pilotdatabase</option>, <option value="classPilotDateEntry.html">pilotdateentry</option>, <option value="classPilotLocalDatabase.html">pilotlocaldatabase</option>, <option value="classPilotRecord.html">pilotrecord</option>, <option value="classPilotRecordBase.html">pilotrecordbase</option>, <option value="classPilotSerialDatabase.html">pilotserialdatabase</option>, <option value="classPilotTodoEntry.html">pilottodoentry</option>, <option value="classRecordConduitBase.html">recordconduitbase</option>, <option value="classSorryAction.html">sorryaction</option>, <option value="classSyncAction_1_1SyncMode.html">syncaction::syncmode</option>, <option value="classTestLink.html">testlink</option>, <option value="classWelcomeAction.html">welcomeaction</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../../akregator/html/index.html">akregator</a></li><li> <a href="../../../akregator/src/html/index.html">src</a></li><li> <a href="../../../akregator/src/librss/html/index.html">librss</a></li><li><a href="../../../certmanager/html/index.html">certmanager</a></li><li> <a href="../../../certmanager/lib/html/index.html">lib</a></li><li><a href="../../../kaddressbook/html/index.html">kaddressbook</a></li><li><a href="../../../kalarm/html/index.html">kalarm</a></li><li> <a href="../../../kalarm/lib/html/index.html">lib</a></li><li><a href="../../../kandy/html/index.html">kandy</a></li><li><a href="../../../karm/html/index.html">karm</a></li><li><a href="../../../kdgantt/html/index.html">kdgantt</a></li><li><a href="../../../kgantt/html/index.html">kgantt</a></li><li><a href="../../../kioslaves/html/index.html">kioslaves</a></li><li> <a href="../../../kioslaves/imap4/html/index.html">imap4</a></li><li> <a href="../../../kioslaves/mbox/html/index.html">mbox</a></li><li><a href="../../../kitchensync/html/index.html">kitchensync</a></li><li><a href="../../../kmail/html/index.html">kmail</a></li><li><a href="../../../knotes/html/index.html">knotes</a></li><li><a href="../../../konsolekalendar/html/index.html">konsolekalendar</a></li><li><a href="../../../kontact/html/index.html">kontact</a></li><li><a href="../../../korganizer/html/index.html">korganizer</a></li><li><a href="../../../kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/kpilot/html/index.html">kpilot</a></li><li> <a href="../../../kpilot/lib/html/index.html">lib</a></li><li><a href="../../../libemailfunctions/html/index.html">libemailfunctions</a></li><li><a href="../../../libkcal/html/index.html">libkcal</a></li><li><a href="../../../libkdepim/html/index.html">libkdepim</a></li><li><a href="../../../libkholidays/html/index.html">libkholidays</a></li><li><a href="../../../libkmime/html/index.html">libkmime</a></li><li><a href="../../../libkpgp/html/index.html">libkpgp</a></li><li><a href="../../../libkpimidentities/html/index.html">libkpimidentities</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
