<?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: KPilotLocalLink 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>KPilotLocalLink Class Reference</h1><!-- doxytag: class="KPilotLocalLink" --><!-- doxytag: inherits="KPilotLink" --><code>#include <<a class="el" href="kpilotlocallink_8h-source.html">kpilotlocallink.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for KPilotLocalLink:</div> <div class="dynsection"> <p><center><img src="classKPilotLocalLink.png" usemap="#KPilotLocalLink_map" border="0" alt=""></center> <map name="KPilotLocalLink_map"> <area href="classKPilotLink.html" alt="KPilotLink" shape="rect" coords="0,0,98,24"> </map> </div> <p> <a href="classKPilotLocalLink-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> Implementation of the device link for file-system backed (ie. <p> local, fake) devices. Uses a directory specified in the <a class="el" href="classKPilotLocalLink.html#9470de850efffba547c6d1d20260819f" title="Assuming things have been set up at least once already by a call to reset() with...">reset()</a> call to serve databases. <p>Definition at line <a class="el" href="kpilotlocallink_8h-source.html#l00043">43</a> of file <a class="el" href="kpilotlocallink_8h-source.html">kpilotlocallink.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Slots</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="961214b5a5d7a9348c44a0050389ebae"></a><!-- doxytag: member="KPilotLocalLink::ready" ref="961214b5a5d7a9348c44a0050389ebae" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>ready</b> ()</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="d3f1b2a5d595496f480f2563b0e399db"></a><!-- doxytag: member="KPilotLocalLink::KPilotLocalLink" ref="d3f1b2a5d595496f480f2563b0e399db" args="(QObject *parent=0L, const char *name=0L)" --> </td><td class="memItemRight" valign="bottom"><b>KPilotLocalLink</b> (QObject *parent=0L, const char *name=0L)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#7a9bba30313df9e1b7493a2bf2f4277f">statusString</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#0a5014385a9de63bba1951744b2f4236">isConnected</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#980f2b3fe66f326b258b146369fd593b">reset</a> (const QString &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#9621ac0835d3a646e434afe52244a2f5">close</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#9470de850efffba547c6d1d20260819f">reset</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#e1e3ac500f51936d891f7d7d26fde076">tickle</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const KPilotCard * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#deab871b6378afdd08e66e7aae425f89">getCardInfo</a> (int card)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#65c550e501c7e1e411d5a2d2c60008f6">endSync</a> (<a class="el" href="classKPilotLink.html#61758d52e6a0684866d82f5ba224f8c9">EndOfSyncFlags</a> f)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#fdc04ebf3e17d6ace9854a2543db0240">openConduit</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#7af60c3114cebaf0d9371c36aafeea74">getNextDatabase</a> (int index, struct DBInfo *)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#f75edcd0721edafe4261a9dae9d87fc3">findDatabase</a> (const char *name, struct DBInfo *, int index=0, unsigned long type=0, unsigned long creator=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#c4568ffef037ed5833412ab0c30799ba">retrieveDatabase</a> (const QString &path, struct DBInfo *db)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classKPilotLink.html#a36b97890b47c51a47d2dcd60a84c1d3">DBInfoList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#e414124a0c710d1563cc5ecdabd73610">getDBList</a> (int cardno=0, int flags=dlpDBListRAM)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classPilotDatabase.html">PilotDatabase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#c2c221a7cbeeecb373b68cff65ad2ef6">database</a> (const QString &name)</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#7f87e4144e371069987be805918b6960">installFile</a> (const QString &, const bool deleteFile)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#3b61d24f5f413645050b9dc43604205e">addSyncLogEntryImpl</a> (const QString &s)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#457309503c1c5c2c4883163c6740ee08">pilotSocket</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPilotLocalLink.html#69cec72316a0254ec1ca38062d11e710">findAvailableDatabases</a> (Private &, const QString &path)</td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8af6b2859301c7d36f93d563aba5a4ac"></a><!-- doxytag: member="KPilotLocalLink::fReady" ref="8af6b2859301c7d36f93d563aba5a4ac" args="" --> bool </td><td class="memItemRight" valign="bottom"><b>fReady</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c22a9261ede0cbd24b64a45da2570d76"></a><!-- doxytag: member="KPilotLocalLink::fPath" ref="c22a9261ede0cbd24b64a45da2570d76" args="" --> QString </td><td class="memItemRight" valign="bottom"><b>fPath</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="993940ec79dcce5129f3b939e3624334"></a><!-- doxytag: member="KPilotLocalLink::d" ref="993940ec79dcce5129f3b939e3624334" args="" --> Private * </td><td class="memItemRight" valign="bottom"><b>d</b></td></tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="7a9bba30313df9e1b7493a2bf2f4277f"></a><!-- doxytag: member="KPilotLocalLink::statusString" ref="7a9bba30313df9e1b7493a2bf2f4277f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">QString KPilotLocalLink::statusString </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Provides a human-readable status string. <p> <p>Implements <a class="el" href="classKPilotLink.html#b033fdc1c4365a18d6c6d63c3d92b0fc">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00135">135</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="0a5014385a9de63bba1951744b2f4236"></a><!-- doxytag: member="KPilotLocalLink::isConnected" ref="0a5014385a9de63bba1951744b2f4236" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool KPilotLocalLink::isConnected </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> True if HotSync has been started but not finished yet (ie. <p> the physical <a class="el" href="namespacePilot.html" title="The Pilot namespace holds constants that are global for the handheld data structures...">Pilot</a> is waiting for sync commands) <p>Implements <a class="el" href="classKPilotLink.html#0d5cf7168473128b7b082876e892d536">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00140">140</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="980f2b3fe66f326b258b146369fd593b"></a><!-- doxytag: member="KPilotLocalLink::reset" ref="980f2b3fe66f326b258b146369fd593b" args="(const QString &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KPilotLocalLink::reset </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>pilotPath</em> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return the device link to the Init state and try connecting to the given device path (if it's non-empty). <p> What the path means depends on the kind of link we're instantiating.<p> <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classKPilotLocalLink.html#9470de850efffba547c6d1d20260819f" title="Assuming things have been set up at least once already by a call to reset() with...">reset()</a> <p> <a class="el" href="classKPilotLink.html#17da9e490e5929d6b5ada57b9488b85b" title="Information on what kind of device we're dealing with.">pilotPath()</a> </dd></dl> <p>Implements <a class="el" href="classKPilotLink.html#8e50e930832f4c92adf53f5ebec8c55b">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00145">145</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="9621ac0835d3a646e434afe52244a2f5"></a><!-- doxytag: member="KPilotLocalLink::close" ref="9621ac0835d3a646e434afe52244a2f5" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KPilotLocalLink::close </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Release all resources, including the master pilot socket, timers, etc. <p> <p>Implements <a class="el" href="classKPilotLink.html#c0ec64e0d61b0035ae93c130b77fe9bd">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00171">171</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="9470de850efffba547c6d1d20260819f"></a><!-- doxytag: member="KPilotLocalLink::reset" ref="9470de850efffba547c6d1d20260819f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KPilotLocalLink::reset </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Assuming things have been set up at least once already by a call to <a class="el" href="classKPilotLocalLink.html#9470de850efffba547c6d1d20260819f" title="Assuming things have been set up at least once already by a call to reset() with...">reset()</a> with parameters, use this slot to re-start with the same settings. <p> <p>Implements <a class="el" href="classKPilotLink.html#3e877d552e0ef8f12c36389a76cefd55">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00152">152</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="e1e3ac500f51936d891f7d7d26fde076"></a><!-- doxytag: member="KPilotLocalLink::tickle" ref="e1e3ac500f51936d891f7d7d26fde076" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool KPilotLocalLink::tickle </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Tickle the underlying device exactly once. <p> <p>Implements <a class="el" href="classKPilotLink.html#a1aa03ed38c1c8940230fd66e6dfa1d2">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00176">176</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="deab871b6378afdd08e66e7aae425f89"></a><!-- doxytag: member="KPilotLocalLink::getCardInfo" ref="deab871b6378afdd08e66e7aae425f89" args="(int card)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const KPilotCard * KPilotLocalLink::getCardInfo </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>card</em> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Retrieve information about the data card <code>card</code>; I don't think that any pilot supports card numbers other than 0. <p> Non-device links return something fake.<p> This function may return NULL (non-device links or on error).<p> <dl class="note" compact><dt><b>Note:</b></dt><dd>Ownership of the KPilotCard object is given to the caller, who must delete it. </dd></dl> <p>Implements <a class="el" href="classKPilotLink.html#12ac9c13081d1205f243c3aeae0cf5c3">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00181">181</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="65c550e501c7e1e411d5a2d2c60008f6"></a><!-- doxytag: member="KPilotLocalLink::endSync" ref="65c550e501c7e1e411d5a2d2c60008f6" args="(EndOfSyncFlags f)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KPilotLocalLink::endSync </td> <td>(</td> <td class="paramtype"><a class="el" href="classKPilotLink.html#61758d52e6a0684866d82f5ba224f8c9">EndOfSyncFlags</a> </td> <td class="paramname"> <em>f</em> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> End the sync in a gracuful manner. <p> If <code>f</code> is UpdateUserInfo, the sync was successful and the user info and last successful sync timestamp are updated. <p>Implements <a class="el" href="classKPilotLink.html#6a4e594890e7f2c8058802c619912fe9">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00186">186</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="fdc04ebf3e17d6ace9854a2543db0240"></a><!-- doxytag: member="KPilotLocalLink::openConduit" ref="fdc04ebf3e17d6ace9854a2543db0240" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int KPilotLocalLink::openConduit </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Notify the <a class="el" href="namespacePilot.html" title="The Pilot namespace holds constants that are global for the handheld data structures...">Pilot</a> user that a conduit is running now. <p> On real devices, this prints out (on screen) which database is now opened; useful for progress reporting.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>-1 on error </dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd>the default implementation returns 0 </dd></dl> <p>Reimplemented from <a class="el" href="classKPilotLink.html#601d9f9b8455f186ab2fe96128f05615">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00192">192</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="7af60c3114cebaf0d9371c36aafeea74"></a><!-- doxytag: member="KPilotLocalLink::getNextDatabase" ref="7af60c3114cebaf0d9371c36aafeea74" args="(int index, struct DBInfo *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int KPilotLocalLink::getNextDatabase </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>index</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct DBInfo * </td> <td class="paramname"> <em>db</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Fill the DBInfo structure <code>db</code> with information about the next database (in some ordering) counting from <code>index</code>. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>< 0 on error </dd></dl> <p>Implements <a class="el" href="classKPilotLink.html#8ba42e37753719be725e16096e82ac57">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00199">199</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="f75edcd0721edafe4261a9dae9d87fc3"></a><!-- doxytag: member="KPilotLocalLink::findDatabase" ref="f75edcd0721edafe4261a9dae9d87fc3" args="(const char *name, struct DBInfo *, int index=0, unsigned long type=0, unsigned long creator=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int KPilotLocalLink::findDatabase </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct DBInfo * </td> <td class="paramname"> <em>info</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>index</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"> <em>type</em> = <code>0</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned long </td> <td class="paramname"> <em>creator</em> = <code>0</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Find a database with the given <code>name</code> (and optionally, type <code>type</code> and creator ID (from pi_mktag) <code>creator</code>, on searching from index <code>index</code> on the handheld. <p> Fills in the DBInfo structure <code>info</code> if found.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>>=0 on success. See the documentation for each subclass for particular meanings. <p> < 0 on error. </dd></dl> <p>Implements <a class="el" href="classKPilotLink.html#2ad0890c23f6ddea8032eb44be665c79">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00221">221</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="c4568ffef037ed5833412ab0c30799ba"></a><!-- doxytag: member="KPilotLocalLink::retrieveDatabase" ref="c4568ffef037ed5833412ab0c30799ba" args="(const QString &path, struct DBInfo *db)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool KPilotLocalLink::retrieveDatabase </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>path</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">struct DBInfo * </td> <td class="paramname"> <em>db</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Retrieve the database indicated by DBInfo <code>*db</code> into the local file <code>path</code>. <p> This copies all the data, and you can create a <a class="el" href="classPilotLocalDatabase.html" title="PilotLocalDatabase represents databases in the same binary format as on the handheld...">PilotLocalDatabase</a> from the resulting <code>path</code> .<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> on success </dd></dl> <p>Implements <a class="el" href="classKPilotLink.html#1f99fd2affb3555a87811db2568c9ea0">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00296">296</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="e414124a0c710d1563cc5ecdabd73610"></a><!-- doxytag: member="KPilotLocalLink::getDBList" ref="e414124a0c710d1563cc5ecdabd73610" args="(int cardno=0, int flags=dlpDBListRAM)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classKPilotLink.html#a36b97890b47c51a47d2dcd60a84c1d3">KPilotLink::DBInfoList</a> KPilotLocalLink::getDBList </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>dlpDBListRAM</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns a list of DBInfo structures describing all the databases available on the link (ie. <p> device) with the given card number <code>cardno</code> and flags <code>flags</code>. No known handheld uses a cardno other than 0; use flags to indicate what kind of databases to fetch -- <code>dlpDBListRAM</code> or <code>dlpDBListROM</code>.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>list of DBInfo objects, one for each database </dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd>ownership of the DBInfo objects is passed to the caller, who must delete the objects. </dd></dl> <p>Implements <a class="el" href="classKPilotLink.html#d385f4be335cf3cb503b8a6164a4d70d">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00340">340</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="c2c221a7cbeeecb373b68cff65ad2ef6"></a><!-- doxytag: member="KPilotLocalLink::database" ref="c2c221a7cbeeecb373b68cff65ad2ef6" args="(const QString &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classPilotDatabase.html">PilotDatabase</a> * KPilotLocalLink::database </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>name</em> </td> <td> ) </td> <td width="100%"><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Return a database object for manipulating the database with name <code>name</code> on the link. <p> This database may be local or remote, depending on the kind of link in use.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to database object, or 0 on error. </dd></dl> <dl class="note" compact><dt><b>Note:</b></dt><dd>ownership of the database object is given to the caller, who must delete the object in time. </dd></dl> <p>Implements <a class="el" href="classKPilotLink.html#94735b8dc57f66856f805b67945c5b7e">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00353">353</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="7f87e4144e371069987be805918b6960"></a><!-- doxytag: member="KPilotLocalLink::installFile" ref="7f87e4144e371069987be805918b6960" args="(const QString &, const bool deleteFile)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool KPilotLocalLink::installFile </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>f</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const bool </td> <td class="paramname"> <em>deleteFile</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Install a single file onto the device link. <p> Full pathname <code>f</code> is used; in addition, if <code>deleteFile</code> is true remove the source file. Returns <code>true</code> if the install succeeded. <p>Implements <a class="el" href="classKPilotLink.html#1f0a3f6c244b3324ecd44b8b1135e3b5">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00269">269</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="3b61d24f5f413645050b9dc43604205e"></a><!-- doxytag: member="KPilotLocalLink::addSyncLogEntryImpl" ref="3b61d24f5f413645050b9dc43604205e" args="(const QString &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void KPilotLocalLink::addSyncLogEntryImpl </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>s</em> </td> <td> ) </td> <td width="100%"><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Actually write an entry to the device link. <p> The message <code>s</code> must be guaranteed non-empty. <p>Implements <a class="el" href="classKPilotLink.html#8b1f27c4461a0f91589e9e34b0e46812">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00263">263</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <a class="anchor" name="457309503c1c5c2c4883163c6740ee08"></a><!-- doxytag: member="KPilotLocalLink::pilotSocket" ref="457309503c1c5c2c4883163c6740ee08" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int KPilotLocalLink::pilotSocket </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> const<code> [inline, protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns a file handle for raw operations. <p> Not recommended. On links with no physical device backing, returns -1.<p> <dl class="note" compact><dt><b>Note:</b></dt><dd>the default implementation returns -1 </dd></dl> <p>Reimplemented from <a class="el" href="classKPilotLink.html#12c8cf7bd8cc77246a8ca47ce23877ec">KPilotLink</a>.</p> <p>Definition at line <a class="el" href="kpilotlocallink_8h-source.html#l00072">72</a> of file <a class="el" href="kpilotlocallink_8h-source.html">kpilotlocallink.h</a>.</p> </div> </div><p> <a class="anchor" name="69cec72316a0254ec1ca38062d11e710"></a><!-- doxytag: member="KPilotLocalLink::findAvailableDatabases" ref="69cec72316a0254ec1ca38062d11e710" args="(Private &, const QString &path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int KPilotLocalLink::findAvailableDatabases </td> <td>(</td> <td class="paramtype">KPilotLocalLink::Private & </td> <td class="paramname"> <em>info</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const QString & </td> <td class="paramname"> <em>path</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Pre-process the directory <code>path</code> to find out which databases live there. <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of database in <code>path</code>. </dd></dl> <p>Definition at line <a class="el" href="kpilotlocallink_8cc-source.html#l00077">77</a> of file <a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.cc</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="kpilotlocallink_8h-source.html">kpilotlocallink.h</a><li><a class="el" href="kpilotlocallink_8cc-source.html">kpilotlocallink.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>