doc/doxygen/latex/win32_2canfestival_8h.tex
author nico
Tue, 05 Jun 2007 18:43:21 +0200
changeset 210 6b5a4c21e061
parent 207 b6572d0336c3
permissions -rw-r--r--
Manual and Documentation finish
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\hypertarget{win32_2canfestival_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/win32/canfestival.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{win32_2canfestival_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/win32/canfestival.h@{/home/epimerde/documents/tc11/CanFestival-3/include/win32/canfestival.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include \char`\"{}timerscfg.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include \char`\"{}can\_\-driver.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
{\tt \#include \char`\"{}data.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
{\tt \#include $<$windows.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
\subsection*{Typedefs}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
typedef HINSTANCE \hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
UNS8 \hyperlink{win32_2canfestival_8h_cb4f394ec0e040c5962d3dc1957505fb}{Un\-Load\-Can\-Driver} (\hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} handle)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
\hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} \hyperlink{win32_2canfestival_8h_a6eed61fc15f41f772d4645d7a5edeb5}{Load\-Can\-Driver} (char $\ast$driver\_\-name)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
UNS8 \hyperlink{win32_2canfestival_8h_8d1909a09c50c750e4d8626595acd9f6}{can\-Send} (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} port, \hyperlink{structMessage}{Message} $\ast$m)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} \hyperlink{win32_2canfestival_8h_7476146ad15948a22e7f80a00c89c40a}{can\-Open} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board, \hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
int \hyperlink{win32_2canfestival_8h_02957f72a9b951603adb98a142bd447b}{can\-Close} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\subsection{Typedef Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\hypertarget{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\index{win32/canfestival.h@{win32/canfestival.h}!LIB_HANDLE@{LIB\_\-HANDLE}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\index{LIB_HANDLE@{LIB\_\-HANDLE}!win32/canfestival.h@{win32/canfestival.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
\subsubsection[LIB\_\-HANDLE]{\setlength{\rightskip}{0pt plus 5cm}typedef HINSTANCE \hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE}}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
\label{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
Definition at line 31 of file canfestival.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
\hypertarget{win32_2canfestival_8h_02957f72a9b951603adb98a142bd447b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
\index{win32/canfestival.h@{win32/canfestival.h}!canClose@{canClose}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\index{canClose@{canClose}!win32/canfestival.h@{win32/canfestival.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
\subsubsection[canClose]{\setlength{\rightskip}{0pt plus 5cm}int can\-Close (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
\label{win32_2canfestival_8h_02957f72a9b951603adb98a142bd447b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
Definition at line 178 of file unix.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
References can\-Close(), struct\_\-CO\_\-Data::can\-Handle, driver\_\-data::continue\_\-receive\_\-thread, DLL\_\-CALL, Enter\-Mutex(), CANPort::fd, driver\_\-data::inst, Leave\-Mutex(), driver\_\-procs::m\_\-can\-Close, driver\_\-data::receive\_\-thread, CANPort::receive\-Task, s\_\-driver\_\-procs, and Wait\-Receive\-Task\-End().\hypertarget{win32_2canfestival_8h_7476146ad15948a22e7f80a00c89c40a}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
\index{win32/canfestival.h@{win32/canfestival.h}!canOpen@{canOpen}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
\index{canOpen@{canOpen}!win32/canfestival.h@{win32/canfestival.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
\subsubsection[canOpen]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} can\-Open (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$ {\em board}, \hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
\label{win32_2canfestival_8h_7476146ad15948a22e7f80a00c89c40a}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
Definition at line 145 of file unix.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
References struct\_\-s\_\-BOARD::baudrate, struct\_\-s\_\-BOARD::busname, struct\_\-CO\_\-Data::can\-Handle, can\-Open(), canports, can\-Receive\-Loop(), driver\_\-data::continue\_\-receive\_\-thread, Create\-Receive\-Task(), driver\_\-data::d, CANPort::d, DLL\_\-CALL, Enter\-Mutex(), CANPort::fd, driver\_\-data::inst, Leave\-Mutex(), driver\_\-procs::m\_\-can\-Open, MAX\_\-NB\_\-CAN\_\-PORTS, driver\_\-data::receive\_\-thread, s\_\-driver\_\-procs, and CANPort::used.\hypertarget{win32_2canfestival_8h_8d1909a09c50c750e4d8626595acd9f6}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
\index{win32/canfestival.h@{win32/canfestival.h}!canSend@{canSend}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
\index{canSend@{canSend}!win32/canfestival.h@{win32/canfestival.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
\subsubsection[canSend]{\setlength{\rightskip}{0pt plus 5cm}UNS8 can\-Send (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} {\em port}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
\label{win32_2canfestival_8h_8d1909a09c50c750e4d8626595acd9f6}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
Definition at line 120 of file unix.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
References can\-Send(), DLL\_\-CALL, Enter\-Mutex(), driver\_\-data::inst, Leave\-Mutex(), driver\_\-procs::m\_\-can\-Send, s\_\-driver\_\-procs, and UNS8.\hypertarget{win32_2canfestival_8h_a6eed61fc15f41f772d4645d7a5edeb5}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
\index{win32/canfestival.h@{win32/canfestival.h}!LoadCanDriver@{LoadCanDriver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
\index{LoadCanDriver@{LoadCanDriver}!win32/canfestival.h@{win32/canfestival.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
\subsubsection[LoadCanDriver]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} Load\-Can\-Driver (char $\ast$ {\em driver\_\-name})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
\label{win32_2canfestival_8h_a6eed61fc15f41f772d4645d7a5edeb5}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
Definition at line 84 of file unix.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
References can\-Close(), can\-Open(), can\-Receive(), can\-Send(), DLSYM, driver\_\-procs::load\_\-canfestival\_\-driver(), and s\_\-driver\_\-procs.\hypertarget{win32_2canfestival_8h_cb4f394ec0e040c5962d3dc1957505fb}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
\index{win32/canfestival.h@{win32/canfestival.h}!UnLoadCanDriver@{UnLoadCanDriver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
\index{UnLoadCanDriver@{UnLoadCanDriver}!win32/canfestival.h@{win32/canfestival.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
\subsubsection[UnLoadCanDriver]{\setlength{\rightskip}{0pt plus 5cm}UNS8 Un\-Load\-Can\-Driver (\hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} {\em handle})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
\label{win32_2canfestival_8h_cb4f394ec0e040c5962d3dc1957505fb}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
Definition at line 71 of file unix.c.