BackupDevice.h

[詳解]

/// @file
/// @brief バックアップ保存先デバイス列挙 BackupDevice のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_BACKUPDEVICE_H
#define AMDAEMON_BACKUPDEVICE_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_backup
/// @{

    /// バックアップ保存先デバイス列挙。
    enum class BackupDevice
    {
        Eeprom = 0, ///< EEPROM。Nuシリーズでのみ有効。
        Sram,       ///< SRAM。Nuシリーズでのみ有効。
        File,       ///< ファイル。ALLSシリーズでのみ有効。
    };

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_BACKUPDEVICE_H