структура winrt::hresult_error (C++/WinRT)

  • Статья

Тип, представляющий код ошибки HRESULT.

Синтаксис

struct hresult_error

Требования

Минимальный поддерживаемый пакет SDK: пакет SDK Windows версии 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, который инициализирует объект hresult_error .

message Информативная строка, помогающая разработчикам исправлять сообщаемое состояние ошибки.

object Объект ошибки, в который хранятся дополнительные сведения об ошибке. Объект ошибки должен иметь значение apartment-agile, in-proc и marshal-by-value в процессах. При необходимости он должен реализовать 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.

См. также раздел