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

  • Статья

Шаблон для структур winrt::handle и winrt::file_handle , среди прочего.

Примечание

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

Синтаксис

template <typename T>
struct handle_type

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

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

Требования

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

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

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

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

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

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

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

Функции элементов

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

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

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

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

Функция Описание
Функция swap Переключает содержимое двух 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 .

Функция swap

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

Синтаксис

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

Параметры

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

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