шаблон структуры winrt::handle_type (C++/WinRT)

  • Статья

Шаблон для структуры winrt::handle и winrt::winrt::file_handle.

Заметка

Вы можете определить собственные признаки дескриптора (например, handle_traits или file_handle_traits в \cppwinrt\winrt\base.h), а также использовать их с winrt::handle_type как typename T. Скопируйте один из этих примеров из base.h в собственный файл исходного кода и укажите собственный тип дескриптора и реализацию. Дополнительные сведения см. в статье msdn Magazine Windows сC++ .

Синтаксис

template <typename T>
struct handle_type

Параметры шаблона

typename T Тип признаков, указывающий тип представляемого дескриптора (дескриптор, дескриптор файла или другой тип).

Требования

минимальный поддерживаемый пакет SDK: windows SDK версии 10.0.17134.0 (Windows 10 версии 1803)

пространство имен : winrt

заголовок : %WindowsSdkDir%Include<WindowsTargetPlatformVersion>\cppwinrt\winrt\base.h (включен по умолчанию)

Псевдонимы типов элементов

Имя псевдонима Тип
handle_type::type Синоним typename T::type, где T является параметром шаблона typename T.

Конструкторы

Конструктор Описание
конструктор handle_type::handle_type Инициализирует новый экземпляр структуры handle_type при необходимости с копированием или перемещением входных данных.

Функции-члены

Функция Описание
handle_type::attach function Присоединяется к значению дескриптора и владеет им.
handle_type::close function Закрывает базовый дескриптор.
функция handle_type::d etach Отсоединяется от базового дескриптора.
handle_type::get function Возвращает базовый дескриптор, который необходимо передать в функцию.
handle_type::p ut function Возвращает адрес базового дескриптора; эта функция помогает вызывать методы, возвращающие ссылки в качестве параметров с помощью указателя на дескриптор.

Операторы-члены

Оператор Описание
handle_type::operator bool Проверяет, представляет ли объект handle_type в данный момент допустимый дескриптор.
handle_type::operator= (оператор назначения) Назначает значение объекту handle_type.

Бесплатные функции

Функция Описание
функции замены Переключает содержимое двух параметров handle_type таким образом, чтобы они содержали дескриптор друг друга.

конструктор handle_type::handle_type

Инициализирует новый экземпляр структуры handle_type при необходимости с копированием или перемещением входных данных.

Синтаксис

handle_type() noexcept;
explicit handle_type(handle_type::type value) noexcept;
handle_type(handle_type&& other) noexcept;

Параметры

value Значение, которое инициализирует объект handle_type.

other Другой handle_type, который инициализирует объект handle_type.

функция handle_type::attach

Присоединяется к значению дескриптора и владеет им.

Синтаксис

void attach(handle_type::type value) noexcept;

Параметры

value значение дескриптора для присоединения.

функция handle_type::close

Закрывает базовый дескриптор.

Синтаксис

void close() noexcept;

функция handle_type::d etach

Отсоединяется от базового дескриптора.

Синтаксис

handle_type::type detach() noexcept;

Возвращаемое значение

Базовый дескриптор, ранее представленный объектом handle_type.

функция handle_type::get

Возвращает базовый дескриптор, необходимо передать его в функцию.

Синтаксис

handle_type::type get() const noexcept;

Возвращаемое значение

Базовый дескриптор, представленный объектом handle_type.

функция handle_type::p ut

Возвращает адрес базового дескриптора; эта функция помогает вызывать методы, возвращающие ссылки в качестве параметров с помощью указателя на дескриптор.

Синтаксис

handle_type::type* put() noexcept;

Возвращаемое значение

Адрес базового дескриптора, представленного объектом handle_type.

handle_type::operator bool

Проверяет, представляет ли объект handle_type в данный момент допустимый дескриптор.

Синтаксис

explicit operator bool() const noexcept;

Возвращаемое значение

true, если объект handle_type в настоящее время представляет допустимый дескриптор, в противном случае false.

handle_type::operator= (оператор назначения)

Назначает значение объекту handle_type.

Синтаксис

winrt::handle_type& operator=(winrt::handle_type&& other) noexcept;

Параметры

other значение handle_type для назначения объекту handle_type.

Возвращаемое значение

Ссылка на объект handle_type.

Функция переключения

Переключает содержимое двух параметров handle_type таким образом, чтобы они содержали дескриптор друг друга.

Синтаксис

void swap(winrt::handle_type& left, winrt::handle_type& right) noexcept;

Параметры

left right значение handle_type, дескриптор которого будет взаимонаправляться с другим параметром.

См. также