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_GetKeySet</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">WM_GetKeySet&nbsp;<img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></H1>
15<h2>Syntax</h2>
16<dl>
17  <dd><PRE><CODE>#include &lt;nitro/wm.h&gt;
18
19<A href="WMErrCode.html">WMErrCode</A> WM_GetKeySet( <A href="WMKeySetBuf.html">WMKeySetBuf</A>* buf, <A href="WMKeySet.html">WMKeySet</A>* keySet );
20</CODE></PRE></dd>
21</dl>
22
23<h2>Arguments</h2>
24<table border="1" width="100%">
25  <tbody>
26    <TR>
27      <TD width="200"><EM><STRONG><FONT face="Courier New">buf</FONT></STRONG></EM></TD>
28      <TD width="800">Pointer to the buffer that stores key information.
29      The entity is the pointer to the <CODE>WMDataSharingInfo</CODE> structure.</TD>
30    </TR>
31    <TR>
32      <TD width="200"><EM><STRONG><FONT face="Courier New"><CODE>keySet</CODE></FONT></STRONG></EM></TD>
33      <TD width="800">A pointer to the keyset read buffer.
34      You must specify a buffer other than the one provided to <A href="WM_StartKeySharing.html"><CODE>WM_StartKeySharing</CODE></A>.</TD>
35    </TR>
36  </tbody>
37</table>
38
39<h2>Return Values</h2>
40<p>Returns the results of the <CODE><A href="WMErrCode.html">WMErrCode</A></CODE> enumerated type process.</p>
41
42<H2>Description</H2>
43<P>Stores <code>WMKeySet</code> and returns it to the buffer specified by the argument <code>WMKeySet</code> is the key information shared by all connected devices. When <em><strong><code>keySet</code></strong></em> is not shared among devices due to a process failure or communication delay, this function returns <code>WM_ERRCODE_NO_KEYSET</code>. Under ideal communication conditions, this function succeeds in every frame even when the <em><strong>mpFreq</strong></em> of <a href="WM_StartMP.html"><code>WM_StartMP</code></a> is 1. However, note that the key data from when <CODE>WM_GetKeySet</CODE> was called successfully two times previously will be loaded into <EM><STRONG>keySet</STRONG></EM>. This restriction is not influenced by the <em><strong><code>mpFreq</code></strong></em> value or the intervals for calling APIs, and it always causes a two-cycle delay. To stabilize the operation in each frame, you must call this function as soon as possible after the V-blank.</P>
44
45<P>The <A href="WM_StartKeySharing.html"><CODE>WM_StartKeySharing</CODE></A>, <A href="WM_EndKeySharing.html"><CODE>WM_EndKeySharing</CODE></A>, and <A href="WM_GetKeySet.html"><CODE>WM_GetKeySet</CODE></A> functions were retained from previous versions to maintain compatibility, but they will be removed in the future. Use the Data Sharing functions instead.</P>
46
47<h2>See Also</h2>
48<p><a href="WM_StartKeySharing.html"><code>WM_StartKeySharing</code></a>, <a href="WM_EndKeySharing.html"><code>WM_EndKeySharing</code></a></p>
49
50<H2>Revision History</H2>
51<P>
522005/06/07 Changed arguments.<br /> 2004/10/22 Changed return value type.<br /> 2004/09/25 Added to and revised Description.<br /> 2004/07/29 Added to Description.<br /> 2004/07/23 Initial version.
53</P>
54<hr><p>CONFIDENTIAL</p></body>
55</html>
56