EMoneyResultStatus.h

[詳解]

/// @file
/// @brief 電子マネー操作の最終状態を表す列挙 EMoneyResultStatus のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_EMONEYRESULTSTATUS_H
#define AMDAEMON_EMONEYRESULTSTATUS_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_emoney
/// @{

    /// 電子マネー操作の最終状態を表す列挙。
    enum class EMoneyResultStatus
    {
        Fail = 0,   ///< 操作失敗。
        Success,    ///< 操作成功。
        Unconfirm,  ///< 支払操作未了。

        /// クレジットを介さない直接支払用の予約値。現実装でこの値が使われることはない。
        Incomplete,
    };

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_EMONEYRESULTSTATUS_H