doc/www/doxygen/html/common_8h.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: common.h File Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>common.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
  24 General header for the <a class="el" href="namespaceBarry.html" title="Project namespace, containing all related functions and classes.">Barry</a> library.
  25 <p>
  26
  27 <p>Definition in file <a class="el" href="common_8h-source.html">common.h</a>.</p>
  28
  29 <p>
  30 <code>#include &quot;<a class="el" href="dll_8h-source.html">dll.h</a>&quot;</code><br>
  31 <code>#include &lt;iostream&gt;</code><br>
  32
  33 <p>
  34 <div class="dynheader">
  35 Include dependency graph for common.h:</div>
  36 <div class="dynsection">
  37 <p><center><img src="common_8h__incl.png" border="0" usemap="#common.h_map" alt=""></center>
  38 <map name="common.h_map">
  39 <area shape="rect" href="dll_8h.html" title="Macros for handling DLL/library API visibility." alt="" coords="5,80,51,107"></map>
  40 </div>
  41
  42 <p>
  43 <div class="dynheader">
  44 This graph shows which files directly or indirectly include this file:</div>
  45 <div class="dynsection">
  46 <p><center><img src="common_8h__dep__incl.png" border="0" usemap="#common.hdep_map" alt=""></center>
  47 <map name="common.hdep_map">
  48 <area shape="rect" href="barry_8h.html" title="Main header file for applications." alt="" coords="71,80,129,107"><area shape="rect" href="common_8cc.html" title="General Barry interface routines." alt="" coords="5,155,93,181"><area shape="rect" href="debug_8h-source.html" title="debug.h" alt="" coords="1949,80,2016,107"><area shape="rect" href="controller_8cc.html" title="High level Barry API class." alt="" coords="117,155,208,181"><area shape="rect" href="probe_8cc.html" title="USB Blackberry detection routines." alt="" coords="232,155,304,181"><area shape="rect" href="iconv_8cc.html" title="iconv wrapper class, and pluggable interface for records" alt="" coords="2040,80,2109,107"><area shape="rect" href="connector_8cc-source.html" title="connector.cc" alt="" coords="3029,155,3125,181"><area shape="rect" href="data_8cc.html" title="Classes to help manage pre&#45;determined data files." alt="" coords="3149,155,3213,181"><area shape="rect" href="dp__codinfo_8cc.html" title="COD debug file parser RIM&#39;s JDE generates several files when you build a COD..." alt="" coords="3237,155,3339,181"><area shape="rect" href="j__manager_8cc.html" title="Application management classes." alt="" coords="3363,155,3461,181"><area shape="rect" href="j__message_8cc.html" title="JDWP USB message implementation." alt="" coords="3485,155,3587,181"><area shape="rect" href="j__server_8cc.html" title="Server protocol implementation." alt="" coords="3611,155,3693,181"><area shape="rect" href="ldif_8cc.html" title="Routines for reading and writing LDAP LDIF data." alt="" coords="3717,155,3773,181"><area shape="rect" href="m__desktop_8cc.html" title="Mode class for the Desktop mode." alt="" coords="3797,155,3901,181"><area shape="rect" href="m__ipmodem_8cc.html" title="Mode class for GPRS modem mode (using endpoints on modern devices)." alt="" coords="3925,155,4035,181"><area shape="rect" href="m__javaloader_8cc.html" title="Mode class for the JavaLoader mode." alt="" coords="328,155,443,181"><area shape="rect" href="m__jvmdebug_8cc.html" title="Mode class for the JVMDebug mode." alt="" coords="467,155,579,181"><area shape="rect" href="m__raw__channel_8cc.html" title="Mode class for a raw channel." alt="" coords="603,155,731,181"><area shape="rect" href="m__serial_8cc.html" title="Mode class for serial / GPRS modem mode." alt="" coords="755,155,843,181"><area shape="rect" href="packet_8cc.html" title="Low level protocol packet builder class." alt="" coords="867,155,944,181"><area shape="rect" href="protocol_8cc.html" title="USB Blackberry bulk protocol API." alt="" coords="968,155,1053,181"><area shape="rect" href="r__bookmark_8cc.html" title="Record parsing class for the phone browser bookmarks database." alt="" coords="1077,155,1184,181"><area shape="rect" href="r__calendar_8cc.html" title="Blackberry database record parser class for calendar records." alt="" coords="1208,155,1307,181"><area shape="rect" href="r__contact_8cc.html" title="Blackberry database record parser class for contact records." alt="" coords="1331,155,1424,181"><area shape="rect" href="r__cstore_8cc.html" title="Blackberry database record parser class for Content Store records." alt="" coords="1448,155,1533,181"><area shape="rect" href="r__dbdb_8cc.html" title="DatabaseDatabase record parser class." alt="" coords="1557,155,1635,181"><area shape="rect" href="r__folder_8cc.html" title="Record parsing class for the folders database." alt="" coords="1659,155,1739,181"><area shape="rect" href="r__message__base_8cc.html" title="Base class for email&#45;oriented Blackberry database records." alt="" coords="1763,155,1901,181"><area shape="rect" href="r__recur__base_8cc.html" title="Base class for recurring calendar event data." alt="" coords="1925,155,2040,181"><area shape="rect" href="r__servicebook_8cc.html" title="Blackberry database record parser class for Service Book records." alt="" coords="2064,155,2184,181"><area shape="rect" href="r__sms_8cc.html" title="Record parsing class for the SMS database." alt="" coords="2208,155,2283,181"><area shape="rect" href="r__task_8cc.html" title="Record parsing class for the task database." alt="" coords="2307,155,2381,181"><area shape="rect" href="r__timezone_8cc.html" title="Record parsing class for the timezone database." alt="" coords="2405,155,2509,181"><area shape="rect" href="record_8cc.html" title="Misc." alt="" coords="2533,155,2608,181"><area shape="rect" href="router_8cc.html" title="Support classes for the pluggable socket routing system." alt="" coords="2632,155,2704,181"><area shape="rect" href="socket_8cc.html" title="Class wrapper to encapsulate the Blackberry USB logical socket." alt="" coords="2728,155,2805,181"><area shape="rect" href="time_8cc.html" title="Conversion between time_t and cenmin_t and back." alt="" coords="2829,155,2893,181"><area shape="rect" href="usbwrap_8cc.html" title="USB API wrapper." alt="" coords="2917,155,3005,181"></map>
  49 </div>
  50
  51 <p>
  52 <a href="common_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
  53 <tr><td></td></tr>
  54 <tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
  55 <tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceBarry.html">Barry</a></td></tr>
  56
  57 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  58 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceBarry.html#2e28bd59aebe0bece5a46f02ef7dbd3d">Barry::Init</a> (bool data_dump_mode, std::ostream *logStream)</td></tr>
  59
  60 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="namespaceBarry.html" title="Project namespace, containing all related functions and classes.">Barry</a> library initializer.  <a href="#2e28bd59aebe0bece5a46f02ef7dbd3d"></a><br></td></tr>
  61 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceBarry.html#59da38213acb8827d30bddfc54bbfe2a">Barry::Verbose</a> (bool data_dump_mode)</td></tr>
  62
  63 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This API call lets the application enable / disable verbose debug output on the fly.  <a href="#59da38213acb8827d30bddfc54bbfe2a"></a><br></td></tr>
  64 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceBarry.html#ec655def4d700239e60ed3ccb417e0c5">Barry::IsVerbose</a> ()</td></tr>
  65
  66 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns true if data dump mode is enabled.  <a href="#ec655def4d700239e60ed3ccb417e0c5"></a><br></td></tr>
  67 </table>
  68 </div>
  69 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:14:07 2011 for Barry by&nbsp;
  70 <a href="http://www.doxygen.org/index.html">
  71 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
  72 </body>
  73 </html>