# MICResult

## 定義

  `#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;

## 要素

MIC_RESULT_SUCCESS | 処理が正常に完了したことを示します。
MIC_RESULT_BUSY | 別のSPI操作処理を実行中であった為、要求は実行できなかったことを示します。
MIC_RESULT_ILLEGAL_PARAMETER | 指定されたパラメータが不正であった為、要求は実行されなかったことを示します。
MIC_RESULT_SEND_ERROR | PXI通信によるARM7へのリクエスト発行に失敗したことを示します。
MIC_RESULT_INVALID_COMMAND | ARM7で受け取ったリクエストがサポート外のコマンドであった為要求は実行不可能であったことを示します。
MIC_RESULT_ILLEGAL_STATUS | MICライブラリ内部状態により、要求を実行できなかったことを示します。例えば、マイクサンプリングを行っていない状態で `MIC_LimitedStopSampling()` をコールした場合です。 あるいは、同期関数を割り込みハンドラ内からコールしたため処理を中断したことを示します。
MIC_RESULT_FATAL_ERROR | 上記以外のなんらかの要因で正常に処理できなかったことを示します。

## 説明

マイクを操作する関数の結果を示す共通の列挙型です。
同期型／非同期型関数の返り値、非同期型関数のユーザコールバックに渡されるresult引数として用いられます。

## 参照

`MICCallback`

## 履歴

Ver. 2009/04/27 MIC_RESULT_ILLEGAL_STATUS を返す条件の具体的な説明を追記
Ver. 2004/06/01 初版