UsbDeviceReconnectResult.h

[詳解]

/// @file
/// @brief USBデバイス再検出処理結果を表す列挙 UsbDeviceReconnectResult のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_USBDEVICERECONNECTRESULT_H
#define AMDAEMON_USBDEVICERECONNECTRESULT_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_usbdevice
/// @{

    /// USBデバイス再検出処理結果を表す列挙。
    enum class UsbDeviceReconnectResult
    {
        None = 0,   ///< 結果未設定。
        Success,    ///< 処理成功。
        Error,      ///< 処理失敗。
        NotFound,   ///< USBデバイスが見つからない。
    };

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_USBDEVICERECONNECTRESULT_H