1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3 4<head> 5<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.2.0 for Windows"> 7<META http-equiv="Content-Style-Type" content="text/css"> 8<title>WM_SetWEPKeyEx</title> 9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 10</head> 11 12<body> 13 14<h1 align="left">WM_SetWEPKeyEx <img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></H1> 15<h2>Syntax</h2> 16<dl> 17 <dd><PRE><CODE>#include <nitro/wm.h> 18 19<A href="WMErrCode.html">WMErrCode</A> WM_SetWEPKeyEx( 20 <A href="WMCallbackFunc.html">WMCallbackFunc</A> callback , 21 u16 wepmode , 22 u16 wepkeyid , 23 const u8* wepkey 24); 25</CODE></PRE></dd> 26</dl> 27 28<h2>Arguments</h2> 29<TABLE width="100%"> 30 <tbody> 31 <TR> 32<TD width="200"><CODE>callback</CODE></TD> 33<TD width="800">Callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.</TD> 34 </TR> 35 <TR> 36<TD width="200"><CODE>wepmode</CODE></TD> 37<TD width="800">Operations mode of the encryption communications feature. Use a value from 0-3, as shown below. 38<UL><LI>0: No encryption features<BR> 39<LI>1: RC4 ( 40-bit) encryption mode <BR> 40<LI>2: RC4 ( 104-bit) encryption mode <BR> 41<LI>3: RC4 (128-bit) encryption mode 42 </UL></TD> 43 </TR> 44 <TR> 45<TD width="200"><CODE>wepkeyid</CODE></TD> 46<TD width="800">Value from 0 to 3 that indicates which of the 4 WEP keys will be used.</TD> 47 </TR> 48 <TR> 49<TD width="200"><CODE>wepkey</CODE></TD> 50<TD width="800">Pointer to the encryption key data (80 bytes).<BR>The key data is made up of 4 data items, each of which are 20 bytes. Of each 20 bytes, 51<UL><LI>In 40-bit mode, 5 bytes 52<LI>In 104-bit mode, 13 bytes 53<LI>In 128-bit mode, 16 bytes 54 </UL> 55are used.<BR>Note that this data is forcibly cached.</TD> 56 </TR> 57 </tbody> 58</table> 59 60<h2>Return Values</h2> 61<p>Returns the results of the <CODE><A href="WMErrCode.html">WMErrCode</A></CODE> enumerated type process.</p> 62 63<H2>Description</H2> 64<P> 65Configures the encryption feature and the encryption keys. Configure advanced settings with the <A href="WM_SetWEPKey.html"><CODE>WM_SetWEPKey</CODE></A> function. It is executable when WM is in an <A href="wm_state_diagram.html">IDLE state</A>. If the return value of the function was <code>WM_ERRCODE_OPERATING</code>, the callback is generated after the encryption feature configuration process has completed. WEP key encryption is applied to the authentication process when connecting and to the sending and receiving of data in infrastructure mode. The <code>wepmode</code> argument must be configured in the same way as its communications partner. The <CODE>wepkeyid</CODE> argument is used in the selection of the encryption data string when sending data. Conversely, the WEP key of the ID designated by the send side is used in decryption when data is received. Since it can be confirmed that the keys are identical by encrypting the child device and decrypting the parent device in shared key authentication, designation of an ID on the parent device has no real meaning. Also, the IDs of the WEP keys designated by the access point must be identical when encrypting receive data in infrastructure mode. Be aware that when connecting the parent that performed the WEP encryption configuration as a child through this function, once the WEP configurations have been performed with this function, the <code>authMode</code> of the <A href="WM_StartConnectEx.html"><CODE>WM_StartConnectEx</CODE></A> function must be designated as shared key authentication (<code>WM_AUTHMODE_SHARED_KEY</code>). 66</P> 67 68<H2>Notes</H2> 69<P>The <CODE>wepkey</CODE> data is forcibly stored in the internal cache. To avoid overwriting surrounding memory regions, be sure to pass data that is 32-byte aligned.<BR>See the Wireless Communication Library Manual (AboutWirelessManager.pdf) for additional details.</P> 70 71<h2>See Also</h2> 72<p><A href="WM_SetWEPKey.html"><CODE>WM_SetWEPKey</CODE></A><BR> <A href="WM_StartConnectEx.html"><CODE>WM_StartConnectEx</CODE></A></p> 73 74<H2>Revision History</H2> 75<P> 762008/12/17 Added a note about how data passed in arguments is forcibly cached internally.<BR>2005/06/08 Added the fact that the callback is called from the interrupt handler.<BR>2005/03/07 Made addition to Description.<BR>2005/03/02 Added mention of the specifiable range of the wepmode argument.<BR>2005/02/14 Initial version.<BR> 77</P> 78<hr><p>CONFIDENTIAL</p></body> 79</html> 80
