RegionCode.h

[詳解]

/// @file
/// @brief 仕向地コード列挙 RegionCode のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_REGIONCODE_H
#define AMDAEMON_REGIONCODE_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_system
/// @{

    /// 仕向地コード列挙。
    enum class RegionCode
    {
        Unknown = 0,    ///< 不明。
        Japan,          ///< 日本国内。
        China,          ///< 中国の繁体字圏。
        Export,         ///< China 以外の輸出国。
    };

    /// @brief 仕向地コードに対応する既定言語名を取得する。
    /// @param[in] regionCode 仕向地コード。
    /// @return 既定言語名。
    ///
    /// Unknown は Export と同等の扱いとなる。
    const wchar_t* getDefaultLanguage(RegionCode regionCode);

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_REGIONCODE_H