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

  • Artículo

Tipo que representa un código de error HRESULT.

Sintaxis

struct hresult_error

Requisitos

SDK mínimo admitido: sdk de Windows versión 10.0.17134.0 (Windows 10, versión 1803)

Espacio de nombres: winrt

Encabezado: %WindowsSdkDir%IncludeWindowsTargetPlatformVersion<>\cppwinrt\winrt\base.h (incluido de forma predeterminada)

Constructores

Constructor Descripción
constructor hresult_error::hresult_error Inicializa una nueva instancia de la estructura hresult_error con una copia de los datos de entrada.

Tipos

Constructor Descripción
tipo hresult_error::from_abi_t Tipo del miembro de datos estático hresult_error::from_abi .

Miembros de datos estáticos

Función Descripción
hresult_error::from_abi miembro de datos estático Instancia de tipo hresult_error::from_abi_t, que se puede pasar al constructor de hresult_error (o un tipo derivado) para indicar que el constructor debe intentar recuperar información de error restringida.

Funciones miembro

Función Descripción
hresult_error::code (función) Recupera el código del error representado por el objeto hresult_error .
hresult_error::message (Función) Recupera el mensaje del error representado por el objeto hresult_error .
función hresult_error::to_abi Establece el objeto de información de error restringido para el subproceso actual y devuelve el código del error representado por el objeto hresult_error .
función hresult_error::try_as Devuelve la interfaz solicitada, si se admite. Devuelve nullptr, o false, si no lo es.

Operadores de miembro

Operator Descripción
hresult_error::operator= (operador de asignación) Asigna un valor al objeto hresult_error .

constructor hresult_error::hresult_error

Inicializa una nueva instancia de la estructura hresult_error con una copia de los datos de entrada.

Sintaxis

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 Otro hresult_error que inicializa el objeto hresult_error .

code Código HRESULT que inicializa el objeto hresult_error .

message Cadena informativa para ayudar a los desarrolladores a corregir la condición de error notificada.

object Objeto de error que almacena información adicional sobre el error. El objeto de error debe ser apartment-agile, in-proc y serializar por valor entre procesos. Debe implementar ILanguageExceptionStackBackTrace e ILanguageExceptionTransform si es necesario. Consulte RoOriginateLanguageException.

hresult_error::code (función)

Recupera el código del error representado por el objeto hresult_error .

Sintaxis

winrt::hresult code() const noexcept;

Valor devuelto

Código de error winrt::hresult .

hresult_error::from_abi miembro de datos estático

Instancia de tipo hresult_error::from_abi_t, que se puede pasar al constructor de hresult_error (o un tipo derivado) para indicar que el constructor debe intentar recuperar información de error restringida.

Sintaxis

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

tipo hresult_error::from_abi_t

Tipo del miembro de datos estático hresult_error::from_abi .

Sintaxis

struct from_abi_t {};

hresult_error::message (Función)

Recupera el mensaje del error representado por el objeto hresult_error .

Sintaxis

winrt::hstring message() const noexcept;

Valor devuelto

Winrt::hstring que contiene el desorden del error.

hresult_error::operator= (operador de asignación)

Asigna un valor al objeto hresult_error .

Sintaxis

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

Parámetros

other Valor de hresult_error que se va a asignar al objeto hresult_error .

Valor devuelto

Referencia al objeto hresult_error .

función hresult_error::to_abi

Establece el objeto de información de error restringido para el subproceso actual y devuelve el código del error representado por el objeto hresult_error .

Sintaxis

HRESULT to_abi() const noexcept;

Valor devuelto

Código de error HRESULT.

función hresult_error::try_as

Devuelve la interfaz solicitada, si se admite. Devuelve nullptr si no es así. Esta función es útil si desea consultar una interfaz que no necesita volver al autor de la llamada. Por ejemplo, puede recuperar un IRestrictedErrorInfo para acceder a la información de error restringida del error representado por el objeto hresult_error .

Sintaxis

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

Parámetros de plantilla

typename To Tipo de la interfaz solicitada.

Parámetros

to Referencia a un valor para recibir la interfaz solicitada.

Valor devuelto

Winrt::com_ptr hacer referencia a la interfaz solicitada o un puntero inteligente fuertemente tipado para la interfaz solicitada (declarada por C++/WinRT o por un tercero), si se admite la interfaz solicitada; de lo contrarionullptr, .

Consulte también