MICResult

Definition

#include <nitro/spi.h>
typedef enum
{
	MIC_RESULT_SUCCESS = 0 ,
	MIC_RESULT_BUSY ,
	MIC_RESULT_ILLEGAL_PARAMETER ,
	MIC_RESULT_SEND_ERROR ,
	MIC_RESULT_INVALID_COMMAND ,
	MIC_RESULT_ILLEGAL_STATUS ,
	MIC_RESULT_FATAL_ERROR ,
	MIC_RESULT_MAX

} MICResult;

Elements

MIC_RESULT_SUCCESS Indicates that the process completed normally.
MIC_RESULT_BUSY Indicates that the request could not be executed because another SPI-operating process is currently running.
MIC_RESULT_ILLEGAL_PARAMETER Indicates that the request was not performed because the specified parameter was illegal.
MIC_RESULT_SEND_ERROR Indicates the failure of a request to ARM7 that was issued using PXI communications.
MIC_RESULT_INVALID_COMMAND Indicates that the request could not be performed because the request received by ARM7 was not a supported command.
MIC_RESULT_ILLEGAL_STATUS Indicates that the request could not be executed because of the internal state of the MIC library. One example is a call to the MIC_LimitedStopSampling function while microphone sampling is not in progress.
This could also indicate that processing was suspended because a synchronous function was called from inside an interrupt handler.
MIC_RESULT_FATAL_ERROR Indicates that proper process was not possible due to a cause not listed above.

Description

This is the list of results shared by functions that operate the microphone.
It is used as a return value for synchronous and asynchronous functions, and the result argument that is passed to the user callback in an asynchronous function.

See Also

MICCallback

Revision History

2009/04/27 Added a specific description of conditions for returning MIC_RESULT_ILLEGAL_STATUS.
2004/06/01 Initial version.


CONFIDENTIAL