doc/doxygen/html/win32_2canfestival_8h.html
author lbessard
Thu, 06 Dec 2007 17:55:46 +0100
changeset 323 4df7e6d2d1db
parent 240 34654679f262
permissions -rw-r--r--
Adding "ParameterValue" as optional parameter for "VAR" entries
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CanFestival: include/win32/canfestival.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
  <ul>
    <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    <li id="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="dirs.html"><span>Directories</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    <li><a href="globals.html"><span>Globals</span></a></li>
  </ul></div>
<div class="nav">
<a class="el" href="dir_bb27f6e70a4a8ab6966321815f15a33d.html">include</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_c7d46e648ccfb6549f9bb77df6f733fd.html">win32</a></div>
<h1>canfestival.h File Reference</h1><code>#include &quot;<a class="el" href="win32_2timerscfg_8h-source.html">timerscfg.h</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="can__driver_8h-source.html">can_driver.h</a>&quot;</code><br>
<code>#include &quot;<a class="el" href="data_8h-source.html">data.h</a>&quot;</code><br>
<code>#include &lt;windows.h&gt;</code><br>

<p>
Include dependency graph for canfestival.h:<p><center><img src="win32_2canfestival_8h__incl.png" border="0" usemap="#include/win32/canfestival.h_map" alt=""></center>
<map name="include/win32/canfestival.h_map">
<area href="win32_2timerscfg_8h.html" shape="rect" coords="575,81,655,108" alt="">
<area href="can__driver_8h.html" shape="rect" coords="327,701,415,728" alt="">
<area href="data_8h.html" shape="rect" coords="224,347,277,373" alt="">
<area href="win32_2applicfg_8h.html" shape="rect" coords="577,448,652,475" alt="">
<area href="can_8h.html" shape="rect" coords="471,612,519,639" alt="">
<area href="def_8h.html" shape="rect" coords="471,195,519,221" alt="">
<area href="objdictdef_8h.html" shape="rect" coords="328,600,413,627" alt="">
<area href="objacces_8h.html" shape="rect" coords="332,397,409,424" alt="">
<area href="sdo_8h.html" shape="rect" coords="347,144,395,171" alt="">
<area href="pdo_8h.html" shape="rect" coords="345,245,396,272" alt="">
<area href="states_8h.html" shape="rect" coords="340,448,401,475" alt="">
<area href="lifegrd_8h.html" shape="rect" coords="337,549,404,576" alt="">
<area href="sync_8h.html" shape="rect" coords="343,296,399,323" alt="">
<area href="nmtMaster_8h.html" shape="rect" coords="327,347,415,373" alt="">
<area href="config_8h.html" shape="rect" coords="583,195,647,221" alt="">
<area href="timer_8h.html" shape="rect" coords="465,119,524,145" alt="">
</map>

<p>
This graph shows which files directly or indirectly include this file:<p><center><img src="win32_2canfestival_8h__dep__incl.png" border="0" usemap="#include/win32/canfestival.hdep_map" alt=""></center>
<map name="include/win32/canfestival.hdep_map">
<area href="lifegrd_8c.html" shape="rect" coords="344,5,429,32" alt="">
<area href="nmtMaster_8c.html" shape="rect" coords="333,56,440,83" alt="">
<area href="nmtSlave_8c.html" shape="rect" coords="337,107,436,133" alt="">
<area href="pdo_8c.html" shape="rect" coords="352,157,421,184" alt="">
<area href="sdo_8c.html" shape="rect" coords="353,208,420,235" alt="">
<area href="sync_8c.html" shape="rect" coords="349,259,424,285" alt="">
<area href="unix_8c.html" shape="rect" coords="325,309,448,336" alt="">
<area href="drivers__win32_8cpp.html" shape="rect" coords="288,360,485,387" alt="">
<area href="TestMasterSlave_8h.html" shape="rect" coords="253,411,520,437" alt="">
<area href="TestMasterSlave_8c.html" shape="rect" coords="627,461,893,488" alt="">
<area href="TestMasterMicroMod_8c.html" shape="rect" coords="599,537,921,564" alt="">
<area href="TestMasterMicroMod_8h.html" shape="rect" coords="225,563,548,589" alt="">
<area href="main_8c.html" shape="rect" coords="304,613,469,640" alt="">
<area href="Master_8c.html" shape="rect" coords="653,360,867,387" alt="">
<area href="Slave_8c.html" shape="rect" coords="656,411,864,437" alt="">
</map>

<p>
<a href="win32_2canfestival_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef HINSTANCE&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="win32_2canfestival_8h.html#df21ab161742c7137cd3bcbe1f9145b7">LIB_HANDLE</a></td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="win32_2canfestival_8h.html#a6bd04d2ce9d3601ce0430fa39d7e971">UnLoadCanDriver</a> (<a class="el" href="win32_2canfestival_8h.html#df21ab161742c7137cd3bcbe1f9145b7">LIB_HANDLE</a> handle)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="win32_2canfestival_8h.html#df21ab161742c7137cd3bcbe1f9145b7">LIB_HANDLE</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="win32_2canfestival_8h.html#0012a2aa42ef694bd275c6b5be5c89c7">LoadCanDriver</a> (char *driver_name)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">UNS8&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="win32_2canfestival_8h.html#b510ea6afa8fdc7c55b3fd875c9f5209">canSend</a> (<a class="el" href="win32_2applicfg_8h.html#c5a917a8cacf5edd42ba6486c0c8a243">CAN_PORT</a> port, <a class="el" href="structMessage.html">Message</a> *m)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="win32_2applicfg_8h.html#c5a917a8cacf5edd42ba6486c0c8a243">CAN_PORT</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="win32_2canfestival_8h.html#c32083e9caa1b02f7726a8b87d10ce33">canOpen</a> (<a class="el" href="structstruct__s__BOARD.html">s_BOARD</a> *board, <a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="win32_2canfestival_8h.html#6d6b692e726dee0a5726e6d3db1b1693">canClose</a> (<a class="el" href="structstruct__CO__Data.html">CO_Data</a> *d)</td></tr>

</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="df21ab161742c7137cd3bcbe1f9145b7"></a><!-- doxytag: member="canfestival.h::LIB_HANDLE" ref="df21ab161742c7137cd3bcbe1f9145b7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef HINSTANCE <a class="el" href="win32_2canfestival_8h.html#df21ab161742c7137cd3bcbe1f9145b7">LIB_HANDLE</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="win32_2canfestival_8h-source.html#l00031">31</a> of file <a class="el" href="win32_2canfestival_8h-source.html">canfestival.h</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="6d6b692e726dee0a5726e6d3db1b1693"></a><!-- doxytag: member="canfestival.h::canClose" ref="6d6b692e726dee0a5726e6d3db1b1693" args="(CO_Data *d)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int canClose           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> *&nbsp;</td>
          <td class="paramname"> <em>d</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="unix_8c-source.html#l00178">178</a> of file <a class="el" href="unix_8c-source.html">unix.c</a>.
<p>
References <a class="el" href="unix_8c-source.html#l00178">canClose()</a>, <a class="el" href="data_8h-source.html#l00087">struct_CO_Data::canHandle</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00114">driver_data::continue_receive_thread</a>, <a class="el" href="unix_8c-source.html#l00027">DLL_CALL</a>, <a class="el" href="timers__unix_8c-source.html#l00020">EnterMutex()</a>, <a class="el" href="unix_8c-source.html#l00053">CANPort::fd</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00113">driver_data::inst</a>, <a class="el" href="timers__unix_8c-source.html#l00025">LeaveMutex()</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00060">driver_procs::m_canClose</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00112">driver_data::receive_thread</a>, <a class="el" href="unix_8c-source.html#l00054">CANPort::receiveTask</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00117">s_driver_procs</a>, and <a class="el" href="timers__unix_8c-source.html#l00076">WaitReceiveTaskEnd()</a>.
<p>
Here is the call graph for this function:<p><center><img src="win32_2canfestival_8h_6d6b692e726dee0a5726e6d3db1b1693_cgraph.png" border="0" usemap="#win32_2canfestival_8h_6d6b692e726dee0a5726e6d3db1b1693_cgraph_map" alt=""></center>
<map name="win32_2canfestival_8h_6d6b692e726dee0a5726e6d3db1b1693_cgraph_map">
<area href="unix_8c.html#6d6b692e726dee0a5726e6d3db1b1693" shape="rect" coords="160,5,229,32" alt="">
<area href="timers__unix_8c.html#aa3c568288a54a9398524255602bbce8" shape="rect" coords="152,56,237,83" alt="">
<area href="timers__unix_8c.html#887d197b991c23bc11f626ae688abec7" shape="rect" coords="151,107,239,133" alt="">
<area href="timers__unix_8c.html#b21b041545f4dfc5660514fbc3c2f89c" shape="rect" coords="127,157,263,184" alt="">
</map>

</div>
</div><p>
<a class="anchor" name="c32083e9caa1b02f7726a8b87d10ce33"></a><!-- doxytag: member="canfestival.h::canOpen" ref="c32083e9caa1b02f7726a8b87d10ce33" args="(s_BOARD *board, CO_Data *d)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="win32_2applicfg_8h.html#c5a917a8cacf5edd42ba6486c0c8a243">CAN_PORT</a> canOpen           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structstruct__s__BOARD.html">s_BOARD</a> *&nbsp;</td>
          <td class="paramname"> <em>board</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structstruct__CO__Data.html">CO_Data</a> *&nbsp;</td>
          <td class="paramname"> <em>d</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="unix_8c-source.html#l00145">145</a> of file <a class="el" href="unix_8c-source.html">unix.c</a>.
<p>
References <a class="el" href="can__driver_8h-source.html#l00035">struct_s_BOARD::baudrate</a>, <a class="el" href="can__driver_8h-source.html#l00034">struct_s_BOARD::busname</a>, <a class="el" href="data_8h-source.html#l00087">struct_CO_Data::canHandle</a>, <a class="el" href="unix_8c-source.html#l00145">canOpen()</a>, <a class="el" href="unix_8c-source.html#l00066">canports</a>, <a class="el" href="unix_8c-source.html#l00132">canReceiveLoop()</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00114">driver_data::continue_receive_thread</a>, <a class="el" href="timers__unix_8c-source.html#l00071">CreateReceiveTask()</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00111">driver_data::d</a>, <a class="el" href="unix_8c-source.html#l00055">CANPort::d</a>, <a class="el" href="unix_8c-source.html#l00027">DLL_CALL</a>, <a class="el" href="timers__unix_8c-source.html#l00020">EnterMutex()</a>, <a class="el" href="unix_8c-source.html#l00053">CANPort::fd</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00113">driver_data::inst</a>, <a class="el" href="timers__unix_8c-source.html#l00025">LeaveMutex()</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00059">driver_procs::m_canOpen</a>, <a class="el" href="unix_8c-source.html#l00049">MAX_NB_CAN_PORTS</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00112">driver_data::receive_thread</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00117">s_driver_procs</a>, and <a class="el" href="unix_8c-source.html#l00052">CANPort::used</a>.
<p>
Here is the call graph for this function:<p><center><img src="win32_2canfestival_8h_c32083e9caa1b02f7726a8b87d10ce33_cgraph.png" border="0" usemap="#win32_2canfestival_8h_c32083e9caa1b02f7726a8b87d10ce33_cgraph_map" alt=""></center>
<map name="win32_2canfestival_8h_c32083e9caa1b02f7726a8b87d10ce33_cgraph_map">
<area href="unix_8c.html#c32083e9caa1b02f7726a8b87d10ce33" shape="rect" coords="151,107,220,133" alt="">
<area href="unix_8c.html#f6396866bcbfb45d7272b70731ab39cf" shape="rect" coords="131,157,240,184" alt="">
<area href="timers__unix_8c.html#aa3c568288a54a9398524255602bbce8" shape="rect" coords="299,208,384,235" alt="">
<area href="timers__unix_8c.html#887d197b991c23bc11f626ae688abec7" shape="rect" coords="297,259,385,285" alt="">
<area href="timers__unix_8c.html#09c921f9537f26895843a3c21620855b" shape="rect" coords="123,309,248,336" alt="">
<area href="states_8c.html#5903338b79e219eeb27f61974419fc12" shape="rect" coords="299,107,384,133" alt="">
<area href="drivers__win32_8cpp.html#3fcc13134ab40e532057273c24fadeb3" shape="rect" coords="300,157,383,184" alt="">
<area href="nmtSlave_8c.html#078a76722e34eb36a14a39ecf16f3a9d" shape="rect" coords="436,5,593,32" alt="">
<area href="lifegrd_8c.html#5b34a311b7b97bb79db8e729c2dcbf36" shape="rect" coords="437,56,592,83" alt="">
<area href="pdo_8c.html#f653b9e9cc46d8290b3ce2d6392b5a52" shape="rect" coords="469,107,560,133" alt="">
<area href="sdo_8c.html#c93bfdbec900f0b60386f0a2a5256826" shape="rect" coords="469,157,560,184" alt="">
<area href="sync_8c.html#89ae8cfbfc53c26248d5d91f689c7197" shape="rect" coords="465,208,564,235" alt="">
</map>

</div>
</div><p>
<a class="anchor" name="b510ea6afa8fdc7c55b3fd875c9f5209"></a><!-- doxytag: member="canfestival.h::canSend" ref="b510ea6afa8fdc7c55b3fd875c9f5209" args="(CAN_PORT port, Message *m)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UNS8 canSend           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="win32_2applicfg_8h.html#c5a917a8cacf5edd42ba6486c0c8a243">CAN_PORT</a>&nbsp;</td>
          <td class="paramname"> <em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structMessage.html">Message</a> *&nbsp;</td>
          <td class="paramname"> <em>m</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="unix_8c-source.html#l00120">120</a> of file <a class="el" href="unix_8c-source.html">unix.c</a>.
<p>
References <a class="el" href="canOpenDriver_8c-source.html#l00505">canSend()</a>, <a class="el" href="unix_8c-source.html#l00027">DLL_CALL</a>, <a class="el" href="timers__unix_8c-source.html#l00020">EnterMutex()</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00113">driver_data::inst</a>, <a class="el" href="timers__unix_8c-source.html#l00025">LeaveMutex()</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00058">driver_procs::m_canSend</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00117">s_driver_procs</a>, and <a class="el" href="hcs12_2applicfg_8h-source.html#l00139">UNS8</a>.
<p>
Here is the call graph for this function:<p><center><img src="win32_2canfestival_8h_b510ea6afa8fdc7c55b3fd875c9f5209_cgraph.png" border="0" usemap="#win32_2canfestival_8h_b510ea6afa8fdc7c55b3fd875c9f5209_cgraph_map" alt=""></center>
<map name="win32_2canfestival_8h_b510ea6afa8fdc7c55b3fd875c9f5209_cgraph_map">
<area href="canOpenDriver_8c.html#fab789b9b2ee0ab6c6f27e67d6c03661" shape="rect" coords="132,5,199,32" alt="">
<area href="timers__unix_8c.html#aa3c568288a54a9398524255602bbce8" shape="rect" coords="123,56,208,83" alt="">
<area href="timers__unix_8c.html#887d197b991c23bc11f626ae688abec7" shape="rect" coords="121,107,209,133" alt="">
<area href="canOpenDriver_8c.html#cd855997446329e6b6338fe8644edf11" shape="rect" coords="259,5,371,32" alt="">
</map>

</div>
</div><p>
<a class="anchor" name="0012a2aa42ef694bd275c6b5be5c89c7"></a><!-- doxytag: member="canfestival.h::LoadCanDriver" ref="0012a2aa42ef694bd275c6b5be5c89c7" args="(char *driver_name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="win32_2canfestival_8h.html#df21ab161742c7137cd3bcbe1f9145b7">LIB_HANDLE</a> LoadCanDriver           </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>driver_name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="unix_8c-source.html#l00084">84</a> of file <a class="el" href="unix_8c-source.html">unix.c</a>.
<p>
References <a class="el" href="unix_8c-source.html#l00178">canClose()</a>, <a class="el" href="unix_8c-source.html#l00145">canOpen()</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00124">canReceive()</a>, <a class="el" href="canOpenDriver_8c-source.html#l00505">canSend()</a>, <a class="el" href="unix_8c-source.html#l00030">DLSYM</a>, <a class="el" href="drivers__win32_8cpp-source.html#l00094">driver_procs::load_canfestival_driver()</a>, and <a class="el" href="drivers__win32_8cpp-source.html#l00117">s_driver_procs</a>.
<p>
Here is the call graph for this function:<p><center><img src="win32_2canfestival_8h_0012a2aa42ef694bd275c6b5be5c89c7_cgraph.png" border="0" usemap="#win32_2canfestival_8h_0012a2aa42ef694bd275c6b5be5c89c7_cgraph_map" alt=""></center>
<map name="win32_2canfestival_8h_0012a2aa42ef694bd275c6b5be5c89c7_cgraph_map">
<area href="unix_8c.html#6d6b692e726dee0a5726e6d3db1b1693" shape="rect" coords="236,5,305,32" alt="">
<area href="unix_8c.html#c32083e9caa1b02f7726a8b87d10ce33" shape="rect" coords="236,56,305,83" alt="">
<area href="drivers__win32_8cpp.html#3fcc13134ab40e532057273c24fadeb3" shape="rect" coords="229,107,312,133" alt="">
<area href="canOpenDriver_8c.html#fab789b9b2ee0ab6c6f27e67d6c03661" shape="rect" coords="237,157,304,184" alt="">
<area href="classdriver__procs.html#b89079a77f4b4576e9affdad131eae47" shape="rect" coords="160,208,381,235" alt="">
<area href="canOpenDriver_8c.html#cd855997446329e6b6338fe8644edf11" shape="rect" coords="467,157,579,184" alt="">
<area href="classdriver__procs.html#3846a104ee383928288c15421e4c4da7" shape="rect" coords="429,208,616,235" alt="">
</map>

</div>
</div><p>
<a class="anchor" name="a6bd04d2ce9d3601ce0430fa39d7e971"></a><!-- doxytag: member="canfestival.h::UnLoadCanDriver" ref="a6bd04d2ce9d3601ce0430fa39d7e971" args="(LIB_HANDLE handle)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">UNS8 UnLoadCanDriver           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="win32_2canfestival_8h.html#df21ab161742c7137cd3bcbe1f9145b7">LIB_HANDLE</a>&nbsp;</td>
          <td class="paramname"> <em>handle</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>
Definition at line <a class="el" href="unix_8c-source.html#l00071">71</a> of file <a class="el" href="unix_8c-source.html">unix.c</a>.
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jul 2 19:10:36 2007 for CanFestival by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1 </small></address>
</body>
</html>