root / trunk / docs / libwireless / group__wlerror.html @ 1427
History | View | Annotate | Download (5.5 KB)
| 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"/> |
| 5 | <title>libwireless: Error Packets</title> |
| 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 -->
|
| 11 | <div class="navigation" id="top"> |
| 12 | <div class="tabs"> |
| 13 | <ul>
|
| 14 | <li><a href="index.html"><span>Main Page</span></a></li> |
| 15 | <li><a href="modules.html"><span>Modules</span></a></li> |
| 16 | <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 17 | <li><a href="files.html"><span>Files</span></a></li> |
| 18 | </ul>
|
| 19 | </div>
|
| 20 | </div>
|
| 21 | <div class="contents"> |
| 22 | <h1>Error Packets</h1> |
| 23 | <p>Functions for sending and receiving error packets.
|
| 24 | <a href="#_details">More...</a></p> |
| 25 | <table border="0" cellpadding="0" cellspacing="0"> |
| 26 | <tr><td colspan="2"><h2>Functions</h2></td></tr> |
| 27 | <tr><td class="memItemLeft" align="right" valign="top">void </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"> </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 </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"> </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 </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"> </td><td class="mdescRight">Send a string in an error packet. <a href="#ga01c7382a758876fce52c18a3e6c81534"></a><br/></td></tr> |
| 33 | </table>
|
| 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 | <div class="memitem"> |
| 39 | <div class="memproto"> |
| 40 | <table class="memname"> |
| 41 | <tr>
|
| 42 | <td class="memname">void wl_error_register </td> |
| 43 | <td>(</td> |
| 44 | <td class="paramtype">void </td> |
| 45 | <td class="paramname"></td> |
| 46 | <td> ) </td> |
| 47 | <td></td> |
| 48 | </tr>
|
| 49 | </table>
|
| 50 | </div>
|
| 51 | <div class="memdoc"> |
| 52 | |
| 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 | |
| 56 | <p>References <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p> |
| 57 | |
| 58 | </div>
|
| 59 | </div>
|
| 60 | <a class="anchor" id="ga01c7382a758876fce52c18a3e6c81534"></a><!-- doxytag: member="wl_error_group.h::wl_error_send_string" ref="ga01c7382a758876fce52c18a3e6c81534" args="(char *str)" --> |
| 61 | <div class="memitem"> |
| 62 | <div class="memproto"> |
| 63 | <table class="memname"> |
| 64 | <tr>
|
| 65 | <td class="memname">void wl_error_send_string </td> |
| 66 | <td>(</td> |
| 67 | <td class="paramtype">char * </td> |
| 68 | <td class="paramname"> <em>str</em></td> |
| 69 | <td> ) </td> |
| 70 | <td></td> |
| 71 | </tr>
|
| 72 | </table>
|
| 73 | </div>
|
| 74 | <div class="memdoc"> |
| 75 | |
| 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> |
| 79 | <table border="0" cellspacing="2" cellpadding="0"> |
| 80 | <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the error message to send </td></tr> |
| 81 | </table>
|
| 82 | </dd>
|
| 83 | </dl>
|
| 84 | |
| 85 | <p>References <a class="el" href="wireless_8c_source.html#l00285">wl_send_global_packet()</a>.</p> |
| 86 | |
| 87 | </div>
|
| 88 | </div>
|
| 89 | <a class="anchor" id="ga4c737d93fefc9aa8d4f87c9296bfa8a0"></a><!-- doxytag: member="wl_error_group.h::wl_error_unregister" ref="ga4c737d93fefc9aa8d4f87c9296bfa8a0" args="(void)" --> |
| 90 | <div class="memitem"> |
| 91 | <div class="memproto"> |
| 92 | <table class="memname"> |
| 93 | <tr>
|
| 94 | <td class="memname">void wl_error_unregister </td> |
| 95 | <td>(</td> |
| 96 | <td class="paramtype">void </td> |
| 97 | <td class="paramname"></td> |
| 98 | <td> ) </td> |
| 99 | <td></td> |
| 100 | </tr>
|
| 101 | </table>
|
| 102 | </div>
|
| 103 | <div class="memdoc"> |
| 104 | |
| 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> |
| 108 | |
| 109 | <p>References <a class="el" href="wireless_8c_source.html#l00362">wl_unregister_packet_group()</a>.</p> |
| 110 | |
| 111 | </div>
|
| 112 | </div>
|
| 113 | </div>
|
| 114 | <hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by |
| 115 | <a href="http://www.doxygen.org/index.html"> |
| 116 | <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
| 117 | </body>
|
| 118 | </html>
|