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 http-equiv="Content-Style-Type" content="text/css"> 7<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css"> 8<title>MPError</title> 9</head> 10 11<body> 12 13<h1>MPError</h1> 14 15<h2>Definitions</h2> 16<dl><dd> 17<pre><code> 18#include <revolution/mp.h> 19 20#define MP_RESULT_MP_ERROR_FLAG 0xffffff00 21#define MP_RESULT_WD_ERROR_FLAG 0x80008000 22 23typedef enum 24{ 25 MP_RESULT_OK = 0, 26 MP_RESULT_CLOSED = ( MP_RESULT_MP_ERROR_FLAG | 0x00 ), // -256 27 MP_RESULT_ILLEGAL_PARAMETER = ( MP_RESULT_MP_ERROR_FLAG | 0x01 ), // -255 28 MP_RESULT_ALREADY_IN_USE = ( MP_RESULT_MP_ERROR_FLAG | 0x06 ), // -250 29 MP_RESULT_NOT_ENOUGH_MEMORY = ( MP_RESULT_MP_ERROR_FLAG | 0x10 ), // -240 30 MP_RESULT_NOT_ENOUGH_RESOURCE = ( MP_RESULT_MP_ERROR_FLAG | 0x11 ), // -239 31 MP_RESULT_NOT_ALLOWED = ( MP_RESULT_MP_ERROR_FLAG | 0x12 ), // -238 32 MP_RESULT_BUSY = ( MP_RESULT_MP_ERROR_FLAG | 0x13 ), // -237 33 MP_RESULT_ILLEGAL_STATE = ( MP_RESULT_MP_ERROR_FLAG | 0x14 ), // -236 34 MP_RESULT_TIMEOUT = ( MP_RESULT_MP_ERROR_FLAG | 0x15 ), // -235 35 MP_RESULT_NO_DATA = ( MP_RESULT_MP_ERROR_FLAG | 0x16 ), // -234 36 MP_RESULT_FAILURE = ( MP_RESULT_MP_ERROR_FLAG | 0x17 ), // -233 37 MP_RESULT_FATAL_ERROR = ( MP_RESULT_MP_ERROR_FLAG | 0xff ), // -1 38 MP_RESULT_WD_CLOSED = ( MP_RESULT_WD_ERROR_FLAG | 0x00 ), 39 MP_RESULT_WD_ILLEGAL_PARAMETER = ( MP_RESULT_WD_ERROR_FLAG | 0x01 ), 40 MP_RESULT_WD_UNAVAILABLE_COMMAND = ( MP_RESULT_WD_ERROR_FLAG | 0x02 ), 41 MP_RESULT_WL_FAILURE = ( MP_RESULT_WD_ERROR_FLAG | 0x03 ), 42 MP_RESULT_WD_INSUFFICIENT_BUFFER = ( MP_RESULT_WD_ERROR_FLAG | 0x04 ), 43 MP_RESULT_WD_FAIL_IOBUF = ( MP_RESULT_WD_ERROR_FLAG | 0x05 ), 44 MP_RESULT_WD_ALREADY_IN_USE = ( MP_RESULT_WD_ERROR_FLAG | 0x06 ) 45} MPResult; 46</code></pre> 47</dd></dl> 48 49<H2>Description</H2> 50<p> 51The constant that indicates the processing results of each function in the MP library. 52</p> 53<TABLE border="1"> 54 <TBODY> 55 <tr> 56<th><strong>Member</strong></th> 57<th><strong>Description</strong></th> 58 </tr> 59 <TR> 60<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_OK</strong></em></td> 61<TD width="520">The process ended normally.</TD> 62 </TR> 63 <TR> 64<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_CLOSED</strong></em></td> 65<TD width="520">Failed because the process has already ended.</TD> 66 </TR> 67 <TR> 68<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_ILLEGAL_PARAMETER</strong></em></td> 69<TD width="520">The parameter is invalid.</TD> 70 </TR> 71 <TR> 72<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_ALREADY_IN_USE</strong></em></td> 73<TD width="520">Resources that need to be use are already in other uses; the request could not be completed.<BR>While the wireless module is being used for Internet use, this error will result when MPStartup() is called.</TD> 74 </TR> 75 <TR> 76<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_NOT_ENOUGH_MEMORY</strong></em></td> 77<TD width="520">Memory could not be allocated.<BR>If a memory allocation error occurs in a place where an error value cannot be returned, this results internally in a FatalError state, which will result in all subsequently called functions failing with MP_RESULT_FATAL_ERROR.</TD> 78 </TR> 79 <TR> 80<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_NOT_ALLOWED</strong></em></td> 81<TD width="520">Not permitted.<BR>This is returned, for example, when <code>MPStartup()</code> is used on channels for which use is not permitted.</TD> 82 </TR> 83 <TR> 84<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_BUSY</strong></em></td> 85<TD width="520">Could not be run because of a temporary lack of resources. Retry after waiting for a short time.</TD> 86 </TR> 87 <TR> 88<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_ILLEGAL_STATE</strong></em></td> 89<TD width="520">A function that cannot be called in the current MP library state was called.</TD> 90 </TR> 91 <TR> 92<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_TIMEOUT</strong></em></td> 93<TD width="520">The transition failed to complete within a set time when attempting to perform an internal status transition. Retry after waiting for a short time.</TD> 94 </TR> 95 <TR> 96<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_NO_DATA</strong></em></td> 97<TD width="520">There was no data to be processed. Generated by the <code>MPDSStep()</code> and <code>MPDSTryStep()</code> functions.</TD> 98 </TR> 99 <TR> 100<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_FATAL_ERROR</strong></em></td> 101<TD width="520">Processing cannot continue as a fatal error has occurred.<BR>For example, if a memory allocation error occurs in a place where an error value cannot be returned, this results internally in a FatalError state, which will result in all subsequently called functions failing with MP_RESULT_FATAL_ERROR.<BR>You can check the cause of the fatal error by examining the return value for <code>MPGetFatalError()</code>.</TD> 102 </TR> 103 <TR> 104<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_WD_CLOSED</strong></em></td> 105<TD width="520">This is an error code returned from a library that MP is using internally. This is not normally made known to the application.</TD> 106 </TR> 107 <TR> 108<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_WD_ILLEGAL_PARAMETER</strong></em></td> 109<TD width="520">This is an error code returned from a library that MP is using internally. This is not normally made known to the application.</TD> 110 </TR> 111 <TR> 112<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_WD_UNAVAILABLE_COMMAND</strong></em></td> 113<TD width="520">This is an error code returned from a library that MP is using internally. This is not normally made known to the application.</TD> 114 </TR> 115 <TR> 116<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_WL_FAILURE</strong></em></td> 117<TD width="520">This is an error code returned from a library that MP is using internally. This is not normally made known to the application.</TD> 118 </TR> 119 <TR> 120<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_WD_INSUFFICIENT_BUFFER</strong></em></td> 121<TD width="520">This is an error code returned from a library that MP is using internally. This is not normally made known to the application.</TD> 122 </TR> 123 <TR> 124<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_WD_FAIL_IOBUF</strong></em></td> 125<TD width="520">This is an error code returned from a library that MP is using internally. This is not normally made known to the application.</TD> 126 </TR> 127 <TR> 128<td valign="top" width="120" bgcolor="#ffffe8"><em><strong>MP_RESULT_WD_ALREADY_IN_USE</strong></em></td> 129<TD width="520">This is an error code returned from a library that MP is using internally. This is not normally made known to the application.</TD> 130 </TR> 131 </TBODY> 132</TABLE> 133 134<h2>See Also</h2> 135<p> 136<code><a href="./MPStartup.html">MPStartup()</a></code>, <code><a href="./MPCleanup.html">MPCleanup()</a></code>, <code><a href="./MPSetUserGameInfo.html">MPSetUserGameInfo()</a></code>, <code><a href="./MPSetEntryFlag.html">MPSetEntryFlag()</a></code>, <code><a href="./MPDisconnect.html">MPDisconnect()</a></code>, <code><a href="./MPGetLinkLevel.html">MPGetLinkLevel()</a></code>, <code><a href="./MPSend.html">MPSend()</a></code>, <code><a href="./MPSendAsync.html">MPSendAsync()</a></code>, <code><a href="./MPUpdateBeacon.html">MPUpdateBeacon()</a></code>, <code><a href="./MPUpdateBeaconAsync.html">MPUpdateBeaconAsync()</a></code> 137</p> 138 139<H2>Revision History</H2> 140<p> 1412007/11/28 Changes and additions to error values.<br>2006/07/03 Initial version. 142</p> 143 144<hr><p>CONFIDENTIAL</p></body> 145</html> 146