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

Type représentant un code d’erreur HRESULT.

Syntaxe

struct hresult_error

Spécifications

Kit de développement logiciel (SDK) pris en charge minimum : Windows SDK version 10.0.0.17134.0 (Windows 10, version 1803)

Espace de noms : winrt

En-tête : %WindowsSdkDir%IncludeWindowsTargetPlatformVersion<>\cppwinrt\winrt\base.h (inclus par défaut)

Constructeurs

Constructeur Description
constructeur hresult_error::hresult_error Initialise une nouvelle instance du struct hresult_error avec une copie des données d’entrée.

Types

Constructeur Description
hresult_error::from_abi_t type Type du membre de données statique hresult_error::from_abi .

Données membres statiques

Fonction Description
hresult_error::from_abi membre de données statiques Instance de type hresult_error::from_abi_t, qui peut être transmise au constructeur de hresult_error (ou un type dérivé) pour indiquer que le constructeur doit essayer de récupérer des informations d’erreur restreintes.

Fonctions Membre

Fonction Description
hresult_error:code, fonction Récupère le code de l’erreur représentée par l’objet hresult_error .
hresult_error::message, fonction Récupère le message de l’erreur représentée par l’objet hresult_error .
fonction hresult_error:to_abi Définit l’objet d’informations d’erreur restreinte pour le thread actuel et retourne le code de l’erreur représentée par l’objet hresult_error .
fonction hresult_error::try_as Retourne l’interface demandée, si elle est prise en charge. Retourne nullptr, ou false, si ce n’est pas le cas.

Opérateurs membres

Opérateur Description
hresult_error::operator= (opérateur d’affectation) Affecte une valeur à l’objet hresult_error .

constructeur hresult_error::hresult_error

Initialise une nouvelle instance du struct hresult_error avec une copie des données d’entrée.

Syntaxe

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;

Paramètres

other Une autre hresult_error qui initialise l’objet hresult_error .

code Code HRESULT qui initialise l’objet hresult_error .

message Chaîne informative permettant aux développeurs de corriger la condition d’erreur signalée.

object Objet d’erreur qui stocke des informations supplémentaires sur l’erreur. L’objet d’erreur doit être apartment-agile, in-proc et marshal-by-value entre les processus. Il doit implémenter ILanguageExceptionStackBackTrace et ILanguageExceptionTransform si nécessaire. Consultez RoOriginateLanguageException.

hresult_error:code, fonction

Récupère le code de l’erreur représentée par l’objet hresult_error .

Syntaxe

winrt::hresult code() const noexcept;

Valeur de retour

Code d’erreur winrt::hresult .

hresult_error::from_abi membre de données statiques

Instance de type hresult_error::from_abi_t, qui peut être transmise au constructeur de hresult_error (ou un type dérivé) pour indiquer que le constructeur doit essayer de récupérer des informations d’erreur restreintes.

Syntax

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

hresult_error::from_abi_t type

Type du membre de données statique hresult_error::from_abi .

Syntax

struct from_abi_t {};

hresult_error::message, fonction

Récupère le message de l’erreur représentée par l’objet hresult_error .

Syntaxe

winrt::hstring message() const noexcept;

Valeur de retour

Winrt::hstring contenant le message d’erreur.

hresult_error::operator= (opérateur d’affectation)

Affecte une valeur à l’objet hresult_error .

Syntaxe

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

Paramètres

other Valeur hresult_error à affecter à l’objet hresult_error .

Valeur retournée

Référence à l’objet hresult_error .

fonction hresult_error:to_abi

Définit l’objet d’informations d’erreur restreinte pour le thread actuel et retourne le code de l’erreur représentée par l’objet hresult_error .

Syntaxe

HRESULT to_abi() const noexcept;

Valeur de retour

Code d’erreur HRESULT.

fonction hresult_error::try_as

Retourne l’interface demandée, si elle est prise en charge. Retourne nullptr si ce n’est pas le cas. Cette fonction est utile si vous souhaitez interroger une interface que vous n’avez pas besoin de transmettre à votre appelant. Par exemple, vous pouvez récupérer un IRestrictedErrorInfo pour accéder aux informations d’erreur restreintes pour l’erreur représentée par l’objet hresult_error .

Syntax

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

Paramètres de modèle

typename To Type de l’interface demandée.

Paramètres

to Référence à une valeur pour recevoir l’interface demandée.

Valeur retournée

Winrt::com_ptr référençant l’interface demandée ou un pointeur intelligent fortement typé pour l’interface demandée (déclaré par C++/WinRT ou par un tiers), si l’interface demandée est prise en charge, sinonnullptr.

Voir aussi