winrt::hresult_error 構造体 (C++/WinRT)
HRESULT エラー コードを表す型。
構文
struct hresult_error
必要条件
サポートされている最小 SDK: Windows SDK バージョン 10.0.17134.0 (Windows 10、バージョン 1803)
名前空間: winrt
ヘッダー: %WindowsSdkDir%IncludeWindowsTargetPlatformVersion<>\cppwinrt\winrt\base.h (既定で含まれています)
コンストラクター
コンストラクター | 説明 |
---|---|
hresult_error::hresult_error コンストラクター | 入力データのコピーを使用して 、hresult_error 構造体の新しいインスタンスを初期化します。 |
種類
コンストラクター | 説明 |
---|---|
hresult_error::from_abi_t 型 | hresult_error::from_abi 静的データ メンバーの型。 |
静的データ メンバー
機能 | 説明 |
---|---|
hresult_error::from_abi 静的データ メンバー | hresult_error::from_abi_t 型のインスタンス。hresult_error (または派生型) のコンストラクターに渡して、コンストラクターが制限されたエラー情報を取得することを示すことができます。 |
メンバー関数
機能 | 説明 |
---|---|
hresult_error::code 関数 | hresult_error オブジェクトによって表されるエラーのコードを取得します。 |
hresult_error::message 関数 | hresult_error オブジェクトによって表されるエラーのメッセージを取得します。 |
hresult_error::to_abi 関数 | 現在のスレッドの制限付きエラー情報オブジェクトを設定し、 hresult_error オブジェクトによって表されるエラーのコードを返します。 |
hresult_error::try_as 関数 | サポートされている場合は、要求されたインターフェイスを返します。 nullptr そうでない場合は 、またはfalse 返します。 |
メンバー演算子
演算子 | 説明 |
---|---|
hresult_error::operator= (代入演算子) | hresult_error オブジェクトに値を割り当てます。 |
hresult_error::hresult_error コンストラクター
入力データのコピーを使用して 、hresult_error 構造体の新しいインスタンスを初期化します。
構文
hresult_error() noexcept;
hresult_error(hresult_error&&);
hresult_error(hresult_error const& other);
explicit hresult_error(HRESULT const code) noexcept;
hresult_error(HRESULT const code, winrt::hstring const& message, ::IUnknown* object = nullptr) noexcept;
hresult_error(HRESULT const code, winrt::hresult_error::from_abi_t) noexcept;
パラメーター
other
hresult_error オブジェクトを初期化する別のhresult_error。
code
hresult_error オブジェクトを初期化する HRESULT コード。
message
報告されたエラー状態を開発者が修正するのに役立つ情報文字列。
object
エラーに関する追加情報を格納するエラー オブジェクト。 エラー オブジェクトは、プロセス間でアパートメント アジャイル、インプロセス、マーシャリングバイバリューにする必要があります。 必要に応じて 、ILanguageExceptionStackBackTrace と ILanguageExceptionTransform を実装する 必要があります。 RoOriginateLanguageException を参照してください。
hresult_error::code 関数
hresult_error オブジェクトによって表されるエラーのコードを取得します。
構文
winrt::hresult code() const noexcept;
戻り値
winrt::hresult エラー コード。
hresult_error::from_abi 静的データ メンバー
hresult_error::from_abi_t 型のインスタンス。hresult_error (または派生型) のコンストラクターに渡して、コンストラクターが制限されたエラー情報を取得することを示すことができます。
構文
static constexpr winrt::hresult_error::from_abi_t from_abi{};
hresult_error::from_abi_t 型
hresult_error::from_abi 静的データ メンバーの型。
構文
struct from_abi_t {};
hresult_error::message 関数
hresult_error オブジェクトによって表されるエラーのメッセージを取得します。
構文
winrt::hstring message() const noexcept;
戻り値
エラーの混乱を含む winrt::hstring 。
hresult_error::operator= (代入演算子)
hresult_error オブジェクトに値を割り当てます。
構文
winrt::hresult_error& operator=(winrt::hresult_error&&);
winrt::hresult_error& operator=(winrt::hresult_error const& other) noexcept;
パラメーター
other
hresult_error オブジェクトに割り当てるhresult_error値。
戻り値
hresult_error オブジェクトへの参照。
hresult_error::to_abi 関数
現在のスレッドの制限付きエラー情報オブジェクトを設定し、 hresult_error オブジェクトによって表されるエラーのコードを返します。
構文
HRESULT to_abi() const noexcept;
戻り値
HRESULT エラー コード。
hresult_error::try_as 関数
サポートされている場合は、要求されたインターフェイスを返します。 そうでない場合は返します nullptr
。 この関数は、呼び出し元に戻す必要のないインターフェイスを照会する場合に便利です。 たとえば、 IRestrictedErrorInfo を取得して、 hresult_error オブジェクトによって表されるエラーの制限付きエラー情報にアクセスできます。
構文
template <typename To> auto try_as() const noexcept;
テンプレート パラメーター
typename To
要求されたインターフェイスの型。
パラメーター
to
要求されたインターフェイスを受け取る値への参照。
戻り値
要求されたインターフェイスを参照する winrt::com_ptr 。要求されたインターフェイスがサポートされている場合は、要求されたインターフェイスの厳密に型指定されたスマート ポインター (C++/WinRT またはサード パーティによって宣言されます nullptr
)。