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

  • Artigo

Um tipo que representa um código de erro HRESULT.

Syntax

struct hresult_error

Requisitos

SDK mínimo com suporte: Windows SDK versão 10.0.17134.0 (Windows 10, versão 1803)

Namespace: winrt

Cabeçalho: %WindowsSdkDir%IncludeWindowsTargetPlatformVersion<>\cppwinrt\winrt\base.h (incluído por padrão)

Construtores

Construtor Descrição
Construtor hresult_error::hresult_error Inicializa uma nova instância do struct hresult_error com uma cópia dos dados de entrada.

Tipos

Construtor Descrição
tipo hresult_error::from_abi_t O tipo do membro de dados estáticos hresult_error::from_abi .

Membros de dados static

Função Descrição
hresult_error::from_abi membro de dados estáticos Uma instância do tipo hresult_error::from_abi_t, que pode ser passada para o construtor de hresult_error (ou um tipo derivado) para indicar que o construtor deve tentar recuperar informações de erro restritas.

Funções de membro

Função Descrição
Função hresult_error::code Recupera o código do erro representado pelo objeto hresult_error .
função hresult_error::message Recupera a mensagem do erro representado pelo objeto hresult_error .
Função hresult_error::to_abi Define o objeto de informações de erro restrito para o thread atual e retorna o código para o erro representado pelo objeto hresult_error .
Função hresult_error::try_as Retorna a interface solicitada, se houver suporte. Retorna nullptrou false, se não estiver.

Operadores membros

Operador Descrição
hresult_error::operator= (operador de atribuição) Atribui um valor ao objeto hresult_error .

Construtor hresult_error::hresult_error

Inicializa uma nova instância do struct hresult_error com uma cópia dos dados de entrada.

Sintaxe

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;

Parâmetros

other Outro hresult_error que inicializa o objeto hresult_error .

code Um código HRESULT que inicializa o objeto hresult_error .

message Uma cadeia de caracteres informativa para ajudar os desenvolvedores a corrigir a condição de erro relatada.

object Um objeto de erro que armazena informações extras sobre o erro. O objeto de erro deve ser apartment-agile, in-proc e marshal-by-value entre processos. Ele deve implementar ILanguageExceptionStackBackTrace e ILanguageExceptionTransform , se necessário. Consulte RoOriginateLanguageException.

Função hresult_error::code

Recupera o código do erro representado pelo objeto hresult_error .

Sintaxe

winrt::hresult code() const noexcept;

Valor retornado

Um código de erro winrt::hresult .

hresult_error::from_abi membro de dados estáticos

Uma instância do tipo hresult_error::from_abi_t, que pode ser passada para o construtor de hresult_error (ou um tipo derivado) para indicar que o construtor deve tentar recuperar informações de erro restritas.

Syntax

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

tipo hresult_error::from_abi_t

O tipo do membro de dados estáticos hresult_error::from_abi .

Syntax

struct from_abi_t {};

função hresult_error::message

Recupera a mensagem do erro representado pelo objeto hresult_error .

Sintaxe

winrt::hstring message() const noexcept;

Valor retornado

Um winrt::hstring que contém a bagunça de erro.

hresult_error::operator= (operador de atribuição)

Atribui um valor ao objeto hresult_error .

Sintaxe

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

Parâmetros

other Um valor hresult_error a ser atribuído ao objeto hresult_error .

Valor retornado

Uma referência ao objeto hresult_error .

Função hresult_error::to_abi

Define o objeto de informações de erro restrito para o thread atual e retorna o código para o erro representado pelo objeto hresult_error .

Sintaxe

HRESULT to_abi() const noexcept;

Valor retornado

Um código de erro HRESULT.

Função hresult_error::try_as

Retorna a interface solicitada, se houver suporte. Retorna nullptr se não estiver. Essa função será útil se você quiser consultar uma interface que não precisa passar para o chamador. Por exemplo, você pode recuperar um IRestrictedErrorInfo para acessar as informações de erro restritas do erro representado pelo objeto hresult_error .

Syntax

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

Parâmetros de modelo

typename To O tipo da interface solicitada.

Parâmetros

to Uma referência a um valor para receber a interface solicitada.

Valor retornado

Um winrt::com_ptr referenciando a interface solicitada ou um ponteiro inteligente fortemente tipado para a interface solicitada (declarada por C++/WinRT ou por terceiros), se a interface solicitada tiver suporte, caso contrário nullptr.

Confira também