Project

General

Profile

Revision 1425

Added by Chris Mar almost 10 years ago

updated wireless basic library code and docs

View differences:

group__wlerror.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">
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
<head>
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
3 5
<title>libwireless: Error Packets</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
</head><body>
7
<!-- Generated by Doxygen 1.5.9 -->
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
</head>
9
<body>
10
<!-- Generated by Doxygen 1.6.1 -->
8 11
<div class="navigation" id="top">
9 12
  <div class="tabs">
10 13
    <ul>
......
16 19
  </div>
17 20
</div>
18 21
<div class="contents">
19
<h1>Error Packets</h1>Functions for sending and receiving error packets.  
20
<a href="#_details">More...</a>
21
<p>
22
<h1>Error Packets</h1>
23
<p>Functions for sending and receiving error packets.  
24
<a href="#_details">More...</a></p>
22 25
<table border="0" cellpadding="0" cellspacing="0">
23
<tr><td></td></tr>
24
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
25
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wlerror.html#g3217351e71b892a90ed3ba79ed36e354">wl_error_register</a> (void)</td></tr>
26

  
27
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register this packet group with the wireless library.  <a href="#g3217351e71b892a90ed3ba79ed36e354"></a><br></td></tr>
28
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wlerror.html#g4c737d93fefc9aa8d4f87c9296bfa8a0">wl_error_unregister</a> (void)</td></tr>
29

  
30
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unregister this packet group with the wireless library.  <a href="#g4c737d93fefc9aa8d4f87c9296bfa8a0"></a><br></td></tr>
31
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wlerror.html#g01c7382a758876fce52c18a3e6c81534">wl_error_send_string</a> (char *str)</td></tr>
32

  
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a string in an error packet.  <a href="#g01c7382a758876fce52c18a3e6c81534"></a><br></td></tr>
26
<tr><td colspan="2"><h2>Functions</h2></td></tr>
27
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wlerror.html#ga3217351e71b892a90ed3ba79ed36e354">wl_error_register</a> (void)</td></tr>
28
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register this packet group with the wireless library.  <a href="#ga3217351e71b892a90ed3ba79ed36e354"></a><br/></td></tr>
29
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wlerror.html#ga4c737d93fefc9aa8d4f87c9296bfa8a0">wl_error_unregister</a> (void)</td></tr>
30
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unregister this packet group with the wireless library.  <a href="#ga4c737d93fefc9aa8d4f87c9296bfa8a0"></a><br/></td></tr>
31
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wlerror.html#ga01c7382a758876fce52c18a3e6c81534">wl_error_send_string</a> (char *str)</td></tr>
32
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a string in an error packet.  <a href="#ga01c7382a758876fce52c18a3e6c81534"></a><br/></td></tr>
34 33
</table>
35
<hr><a name="_details"></a><h2>Detailed Description</h2>
36
Functions for sending and receiving error packets. <hr><h2>Function Documentation</h2>
37
<a class="anchor" name="g3217351e71b892a90ed3ba79ed36e354"></a><!-- doxytag: member="wl_error_group.h::wl_error_register" ref="g3217351e71b892a90ed3ba79ed36e354" args="(void)" -->
34
<hr/><a name="_details"></a><h2>Detailed Description</h2>
35
<p>Functions for sending and receiving error packets. </p>
36
<hr/><h2>Function Documentation</h2>
37
<a class="anchor" id="ga3217351e71b892a90ed3ba79ed36e354"></a><!-- doxytag: member="wl_error_group.h::wl_error_register" ref="ga3217351e71b892a90ed3ba79ed36e354" args="(void)" -->
38 38
<div class="memitem">
39 39
<div class="memproto">
40 40
      <table class="memname">
41 41
        <tr>
42
          <td class="memname">void wl_error_register           </td>
42
          <td class="memname">void wl_error_register </td>
43 43
          <td>(</td>
44 44
          <td class="paramtype">void&nbsp;</td>
45
          <td class="paramname">          </td>
45
          <td class="paramname"></td>
46 46
          <td>&nbsp;)&nbsp;</td>
47 47
          <td></td>
48 48
        </tr>
......
50 50
</div>
51 51
<div class="memdoc">
52 52

  
53
<p>
54
Register this packet group with the wireless library. 
55
<p>
56
Register this packet group with the wireless library. This function must be called before any other wl_error function. 
53
<p>Register this packet group with the wireless library. </p>
54
<p>Register this packet group with the wireless library. This function must be called before any other wl_error function. </p>
55

  
57 56
<p>References <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p>
58 57

  
59 58
</div>
60
</div><p>
61
<a class="anchor" name="g01c7382a758876fce52c18a3e6c81534"></a><!-- doxytag: member="wl_error_group.h::wl_error_send_string" ref="g01c7382a758876fce52c18a3e6c81534" args="(char *str)" -->
59
</div>
60
<a class="anchor" id="ga01c7382a758876fce52c18a3e6c81534"></a><!-- doxytag: member="wl_error_group.h::wl_error_send_string" ref="ga01c7382a758876fce52c18a3e6c81534" args="(char *str)" -->
62 61
<div class="memitem">
63 62
<div class="memproto">
64 63
      <table class="memname">
65 64
        <tr>
66
          <td class="memname">void wl_error_send_string           </td>
65
          <td class="memname">void wl_error_send_string </td>
67 66
          <td>(</td>
68 67
          <td class="paramtype">char *&nbsp;</td>
69
          <td class="paramname"> <em>str</em>          </td>
68
          <td class="paramname"> <em>str</em></td>
70 69
          <td>&nbsp;)&nbsp;</td>
71 70
          <td></td>
72 71
        </tr>
......
74 73
</div>
75 74
<div class="memdoc">
76 75

  
77
<p>
78
Send a string in an error packet. 
79
<p>
80
Send an error message as a string.<p>
81
<dl compact><dt><b>Parameters:</b></dt><dd>
76
<p>Send a string in an error packet. </p>
77
<p>Send an error message as a string.</p>
78
<dl><dt><b>Parameters:</b></dt><dd>
82 79
  <table border="0" cellspacing="2" cellpadding="0">
83 80
    <tr><td valign="top"></td><td valign="top"><em>str</em>&nbsp;</td><td>the error message to send </td></tr>
84 81
  </table>
82
  </dd>
85 83
</dl>
86 84

  
87 85
<p>References <a class="el" href="wireless_8c_source.html#l00285">wl_send_global_packet()</a>.</p>
88 86

  
89 87
</div>
90
</div><p>
91
<a class="anchor" name="g4c737d93fefc9aa8d4f87c9296bfa8a0"></a><!-- doxytag: member="wl_error_group.h::wl_error_unregister" ref="g4c737d93fefc9aa8d4f87c9296bfa8a0" args="(void)" -->
88
</div>
89
<a class="anchor" id="ga4c737d93fefc9aa8d4f87c9296bfa8a0"></a><!-- doxytag: member="wl_error_group.h::wl_error_unregister" ref="ga4c737d93fefc9aa8d4f87c9296bfa8a0" args="(void)" -->
92 90
<div class="memitem">
93 91
<div class="memproto">
94 92
      <table class="memname">
95 93
        <tr>
96
          <td class="memname">void wl_error_unregister           </td>
94
          <td class="memname">void wl_error_unregister </td>
97 95
          <td>(</td>
98 96
          <td class="paramtype">void&nbsp;</td>
99
          <td class="paramname">          </td>
97
          <td class="paramname"></td>
100 98
          <td>&nbsp;)&nbsp;</td>
101 99
          <td></td>
102 100
        </tr>
......
104 102
</div>
105 103
<div class="memdoc">
106 104

  
107
<p>
108
Unregister this packet group with the wireless library. 
109
<p>
110
Unregister this packet group with the wireless library. This function must be called after wl_error_register.<p>
111
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wlerror.html#g3217351e71b892a90ed3ba79ed36e354" title="Register this packet group with the wireless library.">wl_error_register</a> </dd></dl>
105
<p>Unregister this packet group with the wireless library. </p>
106
<p>Unregister this packet group with the wireless library. This function must be called after wl_error_register.</p>
107
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__wlerror.html#ga3217351e71b892a90ed3ba79ed36e354" title="Register this packet group with the wireless library.">wl_error_register</a> </dd></dl>
112 108

  
113 109
<p>References <a class="el" href="wireless_8c_source.html#l00362">wl_unregister_packet_group()</a>.</p>
114 110

  
115 111
</div>
116
</div><p>
117 112
</div>
118
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by&nbsp;
113
</div>
114
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 20 12:12:02 2009 for libwireless by&nbsp;
119 115
<a href="http://www.doxygen.org/index.html">
120
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
116
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
121 117
</body>
122 118
</html>

Also available in: Unified diff