/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     mic_Result.h

  Copyright (C)2010 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 26389 $
 *---------------------------------------------------------------------------*/

#ifndef NN_MIC_MIC_RESULT_H_
#define NN_MIC_MIC_RESULT_H_

#include <nn/Result.h>

/*! @file
    @brief      MIC ライブラリの Result 群です。
*/


namespace nn {
namespace mic {
namespace CTR {

    /*
        @brief Result コードの詳細
    */
    enum Description
    {
        DESCRIPTION_MIC_SHELL_CLOSE = 1
    };

/*!
  @name   Result 値
  @{
*/

/*!
    @class nn::mic::CTR::ResultShellClose
    @brief ふたが閉じられているためマイクが使用できないことを示します。

           ふたが閉じられる際にマイクのサンプリングが動作していた場合、自動的にサンプリングを停止し、
           ふたが開けられた際に自動的にサンプリングを再開します。

           ふた閉じ中に使用できない関数は、@ref StartSampling、@ref StopSampling、@ref AdjustSampling になります。
*/
    NN_DEFINE_RESULT_CONST(
        ResultShellClose,
        Result::LEVEL_STATUS, Result::SUMMARY_STATUS_CHANGED, Result::MODULE_NN_MIC, DESCRIPTION_MIC_SHELL_CLOSE
    );
}
}
}

#endif /* NN_MIC_MIC_RESULT_H_ */