PlayErrorId.h

[詳解]

/// @file
/// @brief プレイ状態変更処理失敗時のエラー内容を表す列挙 PlayErrorId のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_PLAYERRORID_H
#define AMDAEMON_PLAYERRORID_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_sequence
/// @{

    /// プレイ状態変更処理失敗時のエラー内容を表す列挙。
    enum class PlayErrorId
    {
        None = 0,           ///< エラー無し。
        InvalidParam,       ///< リクエストパラメータが不正。
        InvalidState,       ///< プレイ状態が不正。プレイ中にプレイ開始呼び出し等。
        CreditPay,          ///< クレジット不足。
        AccountingBegin,    ///< 課金プレイ開始できない。
        AccountingEnd,      ///< 課金プレイ終了できない。
    };

    /// @brief @ref PlayErrorId 列挙値の文字列表現値を取得する。
    /// @param[in] id @ref PlayErrorId 列挙値。
    /// @return @ref PlayErrorId 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @internal ライブラリ実装メモ: enumsToString.cpp で実装。
    const wchar_t* toString(PlayErrorId id);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_PLAYERRORID_H