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

  Copyright (C)2009 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: 26265 $
 *---------------------------------------------------------------------------*/

#ifndef NN_BOSS_BOSS_TASK_ERROR_H_
#define NN_BOSS_BOSS_TASK_ERROR_H_

#include <nn/boss/boss_Const.h>
#include <nn/boss/boss_Result.h>
#include <nn/boss/boss_Types.h>

#ifdef __cplusplus

namespace nn {
namespace boss {


/*!
  @brief        タスクのエラーを表すクラスです。タスクのエラー情報を取得する際に利用します。
*/
class TaskError
{
public:
/*!
  @brief        コンストラクタです。
*/
    explicit TaskError(void);

/*!
  @brief        デストラクタです。
*/
    virtual ~TaskError(void);

/*!
  @brief        クラス内のプロパティの値を取得します。
                下記のプロパティを使用できます。\n
        識別子                  型 \n
        TASK_ERROR_RESULT_CODE  TaskResultCode                  \n
        TASK_COMM_ERROR_CODE    u32                             \n
        TASK_ERROR_MESSAGE      char message[MAX_ERROR_MESSAGE] \n
  @param[in]    type    プロパティの識別子を指定します。
  @param[out]   pValue  値を指定します。
  @param[in]    size    値のサイズを指定します。
  @return       処理の結果が返ります。<BR>
  @retval       Description== @ref ER_INVALID_PROPERTYVALUE 「プロパティ値のポインタがNULLです。」を表すエラー
  @retval       Description== @ref ER_INVALID_PROPERTYTYPE  「プロパティタイプがサポート外です。」を表すエラー
*/
    nn::Result GetProperty(PropertyType type, void* pValue, size_t size);

protected:
    friend class AccessConfig;
    TaskErrorInfo       m_Error;
};

} // end of namespace boss
} // end of namespace nn

#endif // __cplusplus

#endif /* NN_BOSS_BOSS_TASK_ERROR_H_ */