winrt::handle_type, modèle de struct (C++/WinRT)

  • Article

Modèle pour les structs winrt::handle et winrt::file_handle , entre autres.

Notes

Vous pouvez définir vos propres caractéristiques de handle (voir, par exemple, handle_traits ou file_handle_traits in \cppwinrt\winrt\base.h), et les utiliser avec winrt::handle_type comme typename T. Copiez l’un de ces exemples dans base.h votre propre fichier de code source et fournissez votre propre type de handle et implémentation. Pour plus d’informations, consultez l’article msdn Magazine Windows avec C++.

Syntax

template <typename T>
struct handle_type

Paramètres de modèle

typename T Type de caractéristiques qui spécifie le type de handle représenté (handle, handle de fichier ou autre type).

Spécifications

Sdk minimum pris en charge : Windows SDK version 10.0.17134.0 (Windows 10, version 1803)

Espace de noms : winrt

En-tête : %WindowsSdkDir%IncludeWindowsTargetPlatformVersion<>\cppwinrt\winrt\base.h (inclus par défaut)

Alias de type de membre

Nom d'alias Type
handle_type::type Synonyme de typename T::type, où T est le paramètre de typename T modèle.

Constructeurs

Constructeur Description
constructeur handle_type::handle_type Initialise une nouvelle instance du struct handle_type , éventuellement avec une copie ou un déplacement des données d’entrée.

Fonctions Membre

Fonction Description
fonction handle_type::attach S’attache à une valeur de handle et prend possession de celle-ci.
fonction handle_type::close Ferme le handle sous-jacent.
fonction handle_type::d etach Détache du handle sous-jacent.
handle_type::get, fonction Retourne le handle sous-jacent si vous devez le passer à une fonction.
fonction handle_type::p ut Retourne l’adresse du handle sous-jacent ; cette fonction vous aide à appeler des méthodes qui retournent des références en tant que paramètres sortants via un pointeur vers un handle.

Opérateurs membres

Opérateur Description
handle_type::operator bool Vérifie si l’objet handle_type représente actuellement un handle valide.
handle_type::operator= (opérateur d’assignation) Affecte une valeur à l’objet handle_type .

Fonctions gratuites

Fonction Description
swap, fonction Échange le contenu des deux paramètres handle_type afin qu’ils contiennent le handle d’un autre.

constructeur handle_type::handle_type

Initialise une nouvelle instance du struct handle_type , éventuellement avec une copie ou un déplacement des données d’entrée.

Syntaxe

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

Paramètres

value Valeur qui initialise l’objet handle_type .

other Une autre handle_type qui initialise l’objet handle_type .

fonction handle_type::attach

S’attache à une valeur de handle et prend possession de celle-ci.

Syntaxe

void attach(handle_type::type value) noexcept;

Paramètres

value Valeur de handle à attacher.

fonction handle_type::close

Ferme le handle sous-jacent.

Syntax

void close() noexcept;

fonction handle_type::d etach

Détache du handle sous-jacent.

Syntaxe

handle_type::type detach() noexcept;

Valeur de retour

Handle sous-jacent précédemment représenté par l’objet handle_type .

handle_type::get, fonction

Retourne le handle sous-jacent, si vous devez le passer à une fonction.

Syntaxe

handle_type::type get() const noexcept;

Valeur de retour

Handle sous-jacent représenté par l’objet handle_type .

fonction handle_type::p ut

Retourne l’adresse du handle sous-jacent ; cette fonction vous aide à appeler des méthodes qui retournent des références en tant que paramètres sortants via un pointeur vers un handle.

Syntaxe

handle_type::type* put() noexcept;

Valeur de retour

Adresse du handle sous-jacent représenté par l’objet handle_type .

handle_type::operator bool

Vérifie si l’objet handle_type représente actuellement un handle valide.

Syntaxe

explicit operator bool() const noexcept;

Valeur de retour

true si l’objet handle_type représente actuellement un handle valide; sinon false.

handle_type::operator= (opérateur d’assignation)

Affecte une valeur à l’objet handle_type .

Syntaxe

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

Paramètres

other Valeur handle_type à affecter à l’objet handle_type .

Valeur retournée

Référence à l’objet handle_type .

swap, fonction

Échange le contenu des deux paramètres handle_type afin qu’ils contiennent le handle d’un autre.

Syntaxe

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

Paramètres

leftright Valeur handle_type dont le handle doit s’échanger mutuellement avec celui de l’autre paramètre.

Voir aussi