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.0.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>MICResult</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">MICResult <img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></h1>
15
16<h2>Definition</h2>
17
18<dl>
19  <dd>
20<CODE>#include &lt;nitro/spi.h&gt;</CODE><BR>
21  <PRE><CODE>typedef enum
22{
23	MIC_RESULT_SUCCESS = 0 ,
24	MIC_RESULT_BUSY ,
25	MIC_RESULT_ILLEGAL_PARAMETER ,
26	MIC_RESULT_SEND_ERROR ,
27	MIC_RESULT_INVALID_COMMAND ,
28	MIC_RESULT_ILLEGAL_STATUS ,
29	MIC_RESULT_FATAL_ERROR ,
30	MIC_RESULT_MAX
31
32} MICResult;</CODE></PRE>
33  </dd>
34
35</dl><h2>Elements</h2>
36<TABLE border="1" width="100%">
37  <TBODY>
38    <TR>
39<TD width="300"><em><strong><font face="Courier New">MIC_RESULT_SUCCESS</font></strong></em></TD>
40<TD width="700">Indicates that the process completed normally.</TD>
41    </TR>
42    <TR>
43<TD width="300"><em><strong><font face="Courier New">MIC_RESULT_BUSY</font></strong></em></TD>
44<TD width="700">Indicates that the request could not be executed because another SPI-operating process is currently running.</TD>
45    </TR>
46    <TR>
47<TD><em><strong><font face="Courier New">MIC_RESULT_ILLEGAL_PARAMETER</font></strong></em></TD>
48<TD>Indicates that the request was not performed because the specified parameter was illegal.</TD>
49    </TR>
50    <TR>
51<TD width="300"><em><strong><font face="Courier New">MIC_RESULT_SEND_ERROR</font></strong></em></TD>
52<TD width="700">Indicates the failure of a request to ARM7 that was issued using PXI communications.</TD>
53    </TR>
54    <TR>
55<TD width="300"><em><strong><font face="Courier New">MIC_RESULT_INVALID_COMMAND</font></strong></em></TD>
56<TD width="700">Indicates that the request could not be performed because the request received by ARM7 was not a supported command.</TD>
57    </TR>
58    <TR>
59<TD><em><strong><font face="Courier New">MIC_RESULT_ILLEGAL_STATUS</font></strong></em></TD>
60<TD>Indicates that  the request could not be executed because of the internal state of the MIC library. One example is a call to the <code>MIC_LimitedStopSampling</code> function while microphone sampling is not in progress.<br>This could also indicate that processing was suspended because a synchronous function was called from inside an interrupt handler.</TD>
61    </TR>
62    <TR>
63<TD><em><strong><font face="Courier New">MIC_RESULT_FATAL_ERROR</font></strong></em></TD>
64<TD>Indicates that proper process was not possible due to a cause not listed above.</TD>
65    </TR>
66  </TBODY>
67</TABLE>
68
69<H2>Description</H2>
70<P>This is the list of results shared by functions that operate the microphone.<br>It is used as a return value for synchronous and asynchronous functions, and the <B><I><FONT face="Courier New">result</FONT></I></B> argument that is passed to the user callback in an asynchronous function.</P>
71
72<h2>See Also</h2>
73<P><CODE><A href="MICCallback.html">MICCallback</A></CODE></P>
74
75<H2>Revision History</H2>
76<P>2009/04/27 Added a specific description of conditions for returning <CODE>MIC_RESULT_ILLEGAL_STATUS</CODE>. <br>2004/06/01 Initial version.</P>
77<hr><p>CONFIDENTIAL</p></body>
78</html>
79