winrt::hresult_error struct (C++/WinRT)

  • Artikel

Ein Typ, der einen HRESULT-Fehlercode darstellt.

Syntax

struct hresult_error

Requirements (Anforderungen)

Mindest unterstützte SDK: Windows SDK Version 10.0.17134.0 (Windows 10, Version 1803)

Namespace: winrt

Header: %WindowsSdkDir%IncludeWindowsTargetPlatformVersion<>\cppwinrt\winrt\base.h (standardmäßig enthalten)

Konstruktoren

Konstruktor BESCHREIBUNG
hresult_error::hresult_error Konstruktor Initialisiert eine neue Instanz der hresult_error-Struktur mit einer Kopie der Eingabedaten.

Typen

Konstruktor BESCHREIBUNG
hresult_error::from_abi_t Typ Der Typ des hresult_error::from_abi statischen Datenelements.

Statische Datenmember

Funktion BESCHREIBUNG
hresult_error::from_abi statisches Datenelement Eine Instanz des Typs hresult_error::from_abi_t, die an den Konstruktor von hresult_error (oder einen abgeleiteten Typ) übergeben werden kann, um anzugeben, dass der Konstruktor versuchen sollte, eingeschränkte Fehlerinformationen abzurufen.

Memberfunktionen

Funktion BESCHREIBUNG
hresult_error::Codefunktion Ruft den Code für den durch das hresult_error -Objekt dargestellten Fehler ab.
hresult_error::Nachrichtenfunktion Ruft die Nachricht für den Fehler ab, der durch das hresult_error -Objekt dargestellt wird.
hresult_error::to_abi Funktion Legt das eingeschränkte Fehlerinformationsobjekt für den aktuellen Thread fest und gibt den Code für den durch das hresult_error-Objekt dargestellten Fehler zurück.
hresult_error::try_as-Funktion Gibt die angeforderte Schnittstelle zurück, wenn sie unterstützt wird. Gibt nullptr, oder false, wenn es nicht ist.

Memberoperatoren

Operator BESCHREIBUNG
hresult_error::operator= (Zuordnungsoperator) Weist dem hresult_error-Objekt einen Wert zu.

hresult_error::hresult_error Konstruktor

Initialisiert eine neue Instanz der hresult_error-Struktur mit einer Kopie der Eingabedaten.

Syntax

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;

Parameter

other Ein weiteres hresult_error , das das hresult_error-Objekt initialisiert.

code Ein HRESULT-Code, der das hresult_error-Objekt initialisiert .

message Eine informative Zeichenfolge, die Entwicklern hilft, die gemeldete Fehlerbedingung zu korrigieren.

object Ein Fehlerobjekt, das zusätzliche Informationen zu dem Fehler speichert. Das Fehlerobjekt sollte apartment-agile, in-proc- und Marshal-by-Value-Prozesse sein. Es sollte ILanguageExceptionStackBackTrace und ILanguageExceptionTransform bei Bedarf implementieren. Siehe RoOriginateLanguageException.

hresult_error::Codefunktion

Ruft den Code für den durch das hresult_error -Objekt dargestellten Fehler ab.

Syntax

winrt::hresult code() const noexcept;

Rückgabewert

Ein Winrt::hresult-Fehlercode .

hresult_error::from_abi statisches Datenelement

Eine Instanz des Typs hresult_error::from_abi_t, die an den Konstruktor von hresult_error (oder einen abgeleiteten Typ) übergeben werden kann, um anzugeben, dass der Konstruktor versuchen sollte, eingeschränkte Fehlerinformationen abzurufen.

Syntax

static constexpr winrt::hresult_error::from_abi_t from_abi{};

hresult_error::from_abi_t Typ

Der Typ des hresult_error::from_abi statischen Datenelements.

Syntax

struct from_abi_t {};

hresult_error::Nachrichtenfunktion

Ruft die Nachricht für den Fehler ab, der durch das hresult_error -Objekt dargestellt wird.

Syntax

winrt::hstring message() const noexcept;

Rückgabewert

Ein Winrt::hstring , der die Fehlerfehler-Messsage enthält.

hresult_error::operator= (Zuordnungsoperator)

Weist dem hresult_error-Objekt einen Wert zu.

Syntax

winrt::hresult_error& operator=(winrt::hresult_error&&);
winrt::hresult_error& operator=(winrt::hresult_error const& other) noexcept;

Parameter

other Ein hresult_error Wert, der dem hresult_error-Objekt zugewiesen werden soll.

Rückgabewert

Ein Verweis auf das hresult_error-Objekt .

hresult_error::to_abi Funktion

Legt das eingeschränkte Fehlerinformationsobjekt für den aktuellen Thread fest und gibt den Code für den durch das hresult_error-Objekt dargestellten Fehler zurück.

Syntax

HRESULT to_abi() const noexcept;

Rückgabewert

Ein HRESULT-Fehlercode.

hresult_error::try_as-Funktion

Gibt die angeforderte Schnittstelle zurück, wenn sie unterstützt wird. Gibt zurück nullptr , wenn es nicht ist. Diese Funktion ist nützlich, wenn Sie eine Schnittstelle abfragen möchten, die Sie nicht an Ihren Anrufer übergeben müssen. Sie können beispielsweise eine IRestrictedErrorInfo abrufen, um auf die eingeschränkten Fehlerinformationen zuzugreifen, die durch das hresult_error-Objekt dargestellt werden.

Syntax

template <typename To> auto try_as() const noexcept;

Vorlagenparameter

typename To Der Typ der angeforderten Schnittstelle.

Parameter

to Ein Verweis auf einen Wert zum Empfangen der angeforderten Schnittstelle.

Rückgabewert

Ein Winrt::com_ptr verweisen auf die angeforderte Schnittstelle oder einen stark typierten smarten Zeiger für die angeforderte Schnittstelle (entweder von C++/WinRT oder von einem Drittanbieter deklariert), wenn die angeforderte Schnittstelle unterstützt wird, andernfalls nullptr.

Siehe auch