BackupRecordStatus.h

[詳解]

/// @file
/// @brief バックアップレコード状態列挙 BackupRecordStatus のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_BACKUPRECORDSTATUS_H
#define AMDAEMON_BACKUPRECORDSTATUS_H

#include "amdaemon/env.h"

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

    /// バックアップレコード状態列挙。
    enum class BackupRecordStatus
    {
        Valid = 0,  ///< 正常。

        /// @brief 異なるアプリのデータが保存されている。
        ///
        /// 前回データを保存した時のゲームIDおよび仕向地コードと、
        /// バックアップレコードセットアップ時のそれらいずれかが異なる場合にこの値となる。
        ///
        /// @par プラットフォーム情報
        /// ALLSシリーズにおいてはキーチップの仕向地コードがそのまま判定対象となることに注意。
        /// 開発キーチップと量産キーチップを切り替えたい場合等には仕向地コードを揃えること。
        DiffApp,

        /// @brief データが壊れている。(CRCエラー、サイズエラー等)
        ///
        /// バックアップレコードセットアップ時、下記の状態だった場合にこの値となる。
        ///
        /// - 前回データを保存した時と保存位置やデータサイズが異なる場合。
        /// - データが破損している場合。
        BrokenData,

        /// ステータス取得関数の引数エラー。この値が内部値として設定されることはない。
        InvalidCall = -1,
    };

    /// @brief バックアップレコード状態値が正常であるか否かを取得する。
    /// @param[in] status 調べる状態値。
    /// @retval true  正常である場合。
    /// @retval false 正常ではない場合。
    inline bool isValidStatus(BackupRecordStatus status)
    {
        return (status == BackupRecordStatus::Valid);
    }

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_BACKUPRECORDSTATUS_H