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_SetMPFrequency</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">WM_SetMPFrequency&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_SetMPFrequency(
20        <A href="WMCallbackFunc.html">WMCallbackFunc</A>  callback ,
21        u16             mpFreq
22);
23</CODE></PRE></dd>
24</dl>
25
26<h2>Arguments</h2>
27<table border="1" width="100%">
28  <tbody>
29    <TR>
30      <TD width="200"><EM><STRONG><FONT face="Courier New">callback</FONT></STRONG></EM></TD>
31      <TD width="800">Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.</TD>
32    </TR>
33    <TR>
34      <TD width="200"><EM><STRONG><FONT face="Courier New">mpFreq</FONT></STRONG></EM></TD>
35      <TD width="800">Specifies how many times to perform MP communications in one frame.
36      When a value of 0 is specified, this function is set to the continuous packet send mode that is used for large volume data communication.</TD>
37    </TR>
38   </tbody>
39</table>
40
41<h2>Return Values</h2>
42<p>Returns the results of the <CODE><A href="WMErrCode.html">WMErrCode</A></CODE> enumerated type process.</p>
43
44<H2>Description</H2>
45<P>Sets the MP communications frequency This function is only executable when the WM is in the <A href="wm_state_diagram.html"><CODE>MP_PARENT</CODE></A> state. Use this function during MP communications to dynamically change the communications frequency that was set by the <em><strong><code>mpFreq</code></strong></em> argument in <a href="WM_StartMP.html"><code>WM_StartMP</code></a>. If the return value is <code>WM_ERRCODE_OPERATING</code>, a callback is generated after the MP completes the data transmission process.</P>
46<P>This wrapper function calls the <A href="WM_SetMPParameter.html"><CODE>WM_SetMPParameter</CODE></A> function internally.</P>
47
48<h2>See Also</h2>
49<P><code><A href="WM_SetMPParameter.html">WM_SetMPParameter</A>, <A href="WM_StartMP.html">WM_StartMP</A>, <A href="WM_SetMPDataToPort.html">WM_SetMPDataToPort</A></code></P>
50
51<H2>Revision History</H2>
52<P>
532005/12/06 Noted that WM_SetMPParameter had become a wrapper function.<br>2005/06/08 Added the fact that the callback is called from the interrupt handler.<br>2004/10/22 Changed the type of the return value.<BR>2004/09/13 Initial release.
54</P>
55<hr><p>CONFIDENTIAL</p></body>
56</html>
57