Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Modèle de pointeur intelligent COM compté par référence. com_ptr représente un pointeur vers le type d’implémentation de l’interface ou de la classe d’exécution spécifié par le paramètre template. Il gère automatiquement le nombre de références pour sa cible via un pointeur brut privé.
Syntaxe
template <typename T>
struct com_ptr
Paramètres de modèle
typename T L’interface, ou le type d’implémentation de la classe d’exécution, dont le pointeur est représenté par le com_ptr. Il s’agit du type de la cible du pointeur intelligent.
Exigences
SDK minimum pris en charge : Kit de développement logiciel (SDK) Windows version 10.0.17134.0 (Windows 10, version 1803)
Espace de noms : winrt
En-tête : %WindowsSdkDir%Include<WindowsTargetPlatformVersion>\cppwinrt\winrt\base.h (inclus par défaut)
Alias de type membre
| Nom de l’alias | Catégorie |
|---|---|
| com_ptr ::type | Synonyme d’une représentation définie par l’implémentation typename T du paramètre de modèle. |
Constructeurs
| Constructeur | Descriptif |
|---|---|
| com_ptr ::com_ptr constructeur | Initialise une nouvelle instance de la structure com_ptr , éventuellement avec une copie ou un déplacement des données d’entrée. |
Fonctions membres
| Fonction | Descriptif |
|---|---|
| com_ptr ::comme fonction | Retourne l’interface demandée, si elle est prise en charge. Lève si ce n’est pas le cas. |
| com_ptr ::attacher la fonction | Joint à un pointeur brut qui possède une référence à sa cible ; une référence supplémentaire n’est pas ajoutée. |
| Fonction com_ptr ::capture | Appelle une fonction ou une méthode spécifiée (en appelant automatiquement winrt ::check_hresult dessus) et capture le pointeur d’interface qui est généré par la fonction ou la méthode sous la forme d’un void**. |
| Fonction com_ptr ::copy_from | Copie à partir d’un autre pointeur. Décrémente le nombre de références sur n’importe quelle interface ou objet actuellement référencé, copie le paramètre de pointeur brut et commence à gérer la durée de vie de l’interface ou de l’objet vers lequel il pointe. |
| Fonction com_ptr ::copy_to | Copie vers un autre pointeur à partir de l’objet com_ptr . Incrémente le nombre de références sur n’importe quelle interface ou objet actuellement référencé, et copie l’adresse mémoire de l’interface ou de l’objet dans le paramètre. |
| com_ptr ::d fonction etach | Détache de l’interface ou de l’objet référencé sans décrémenter le nombre de références, peut-être pour le renvoyer à un appelant. |
| com_ptr ::get fonction | Retourne le pointeur brut sous-jacent si vous devez le passer à une fonction. |
| Fonction com_ptr ::p ut | Retourne l’adresse du pointeur brut sous-jacent ; cette fonction vous aide à appeler des méthodes (telles que des méthodes COM) qui retournent des références en tant que paramètres sortants via un pointeur vers un pointeur. |
| Fonction com_ptr ::p ut_void | Renvoie l’adresse du pointeur brut sous-jacent en tant que pointeur vers un pointeur à void ; Cette fonction vous permet d’appeler des méthodes (telles que les méthodes COM) qui renvoient des références en tant que paramètres out via un pointeur vers un pointeur vers void. |
| Fonction com_ptr ::try_as | Retourne l’interface demandée, si elle est prise en charge. Renvoie nullptr, ou false, si ce n’est pas le cas. |
| Fonction com_ptr ::try_capture | Une version de com_ptr ::capture qui ne lance pas en cas d’échec mais qui renvoie des retours true en cas de succès ou false d’échec. |
Opérateurs membres
| Opérateur | Descriptif |
|---|---|
| com_ptr ::operator bool | Vérifie si le pointeur intelligent fait référence ou non à une interface ou à un objet. |
| com_ptr ::operator* (opérateur d’indirection) | Renvoie une référence à la cible de l’com_ptr afin que vous puissiez la passer à une fonction qui attend une référence au type de cible T. |
| com_ptr ::operator= (opérateur d’affectation) | Attribue une valeur à l’objet com_ptr . |
| com_ptr ::operator-> (opérateur fléché) | Pour permettre l’accès aux méthodes de l’interface référencée ou de l’objet, retourne le pointeur brut sous-jacent. |
Fonctions gratuites
| Fonction | Descriptif |
|---|---|
| attach_abi fonction | Attache un objet com_ptr à un pointeur brut qui possède une référence à sa cible ; Une référence supplémentaire n’est pas ajoutée. |
| detach_abi fonction | Détache un objet com_ptr de son interface brute sans décrémenter le nombre de références, peut-être pour le renvoyer à un appelant. |
| fonction de swap | Permute le contenu des deux paramètres de com_ptr afin qu’ils pointent vers la cible de l’autre. |
Opérateurs gratuits
| Fonction | Descriptif |
|---|---|
| operator != (opérateur d’inégalité) | Retourne une valeur indiquant si les deux paramètres font référence à des cibles différentes. |
| opérateur< (inférieur à opérateur) | Retourne une valeur indiquant si la cible du premier paramètre se produit plus tôt en mémoire que celle du deuxième paramètre. |
| operator<= (opérateur inférieur ou égal à) | Retourne une valeur indiquant si la cible du premier paramètre se produit plus tôt en mémoire que, ou au même emplacement que celui du deuxième paramètre. |
| operator== (opérateur d’égalité) | Retourne une valeur indiquant si les deux paramètres font référence à la même interface et/ou à l’objet. |
| opérateur> (opérateur supérieur à) | Retourne une valeur indiquant si la cible du premier paramètre se produit plus tard dans la mémoire que celle du deuxième paramètre. |
| operator>= (opérateur supérieur ou égal à) | Retourne une valeur indiquant si la cible du premier paramètre se produit plus tard dans la mémoire que, ou au même emplacement que celui du deuxième paramètre. |
constructeur com_ptr ::com_ptr
Initialise une nouvelle instance de la structure com_ptr , éventuellement avec une copie ou un déplacement des données d’entrée.
Le void* constructeur prend un T* et assume la propriété.
winrt ::take_ownership_from_abi_t est un type de marqueur qui rend explicite la responsabilité de libérer ce pointeur est maintenant transférée à la com_ptr. Le refcount n’a pas besoin d’être exactement 1 ; c’est juste dire que la responsabilité est transférée.
Syntaxe
com_ptr(winrt::com_ptr const& other) noexcept;
com_ptr(std::nullptr_t = nullptr) noexcept;
com_ptr(void* ptr, winrt::take_ownership_from_abi_t) noexcept;
template <typename U> com_ptr(winrt::com_ptr<U> const& other) noexcept;
template <typename U> com_ptr(winrt::com_ptr<U>&& other) noexcept;
Paramètres de modèle
typename U Type de cible pointé par le pointeur intelligent d’entrée.
Paramètres
other Une autre com_ptr qui initialise l’objet com_ptr . Le T du paramètre doit être convertible en T de l’objet com_ptr.
com_ptr ::as, fonction
Retourne l’interface demandée, si elle est prise en charge. Lève si ce n’est pas le cas. Cette fonction est utile si vous souhaitez interroger une interface que vous n’avez pas besoin de renvoyer à votre appelant.
Pour obtenir des exemples de code, consultez la section Instanciation et retour de types et d’interfaces projetés, ainsi que d’autres sections de cette rubrique.
Syntaxe
template <typename To> auto as() const;
template <typename To> void as(To& to) const;
Paramètres de modèle
typename To Le type de l’interface demandée.
Paramètres
to Référence à une valeur pour recevoir l’interface demandée.
Valeur de retour
Un com_ptr référençant l’interface demandée ou un pointeur intelligent fortement typé pour l’interface demandée (déclaré par C++/WinRT ou par un tiers).
com_ptr ::attach, fonction
Joint à un pointeur brut qui possède une référence à sa cible ; une référence supplémentaire n’est pas ajoutée. Si nécessaire, vous pouvez utiliser cette fonction pour fusionner les références.
Syntaxe
void attach(T* value) noexcept;
Paramètres
value Pointeur brut qui possède une référence à sa cible.
com_ptr ::capture, fonction
Appelle une fonction ou une méthode spécifiée (en appelant automatiquement winrt ::check_hresult dessus) et capture le pointeur d’interface qui est généré par la fonction ou la méthode sous la forme d’un void**.
Voir aussi le modèle de fonction winrt ::capture.
Syntaxe
template <typename F, typename...Args>
void capture(F function, Args&&...args);
template <typename O, typename M, typename...Args>
void capture(O* p, M method, Args&& ...args);
template <typename O, typename M, typename...Args>
void capture(winrt::com_ptr<O> const& object, M method, Args&&...args);
Paramètres de modèle
typename F Type d’objet fonction, tel qu’une fonction libre ou std ::function.
typename O Un type d’interface.
typename M Type de méthode.
typename Args Zéro ou plusieurs types d’arguments.
Paramètres
function Objet fonction de type F.
p Pointeur vers un objet de type O.
object Un winrt ::com_ptr de type O.
method Méthode (implémentée par O) de type M.
args Zéro ou plusieurs arguments de type Args.
Remarques
- La
capture(F function, Args&&...args)surcharge appelle l’objet fonction. - La
capture(O* p, M method, Args&& ...args)surcharge appelle la méthode sur le pointeur. - La
capture(winrt::com_ptr<O> const& object, M method, Args&&...args)surcharge appelle la méthode sur l’objet.
Toutes les surcharges passent (à l’appelant) tous les arguments supplémentaires que vous fournissez. Toutes les surcharges passent également les deux arguments supplémentaires requis par de tels appels, à savoir un REFIID (l’ID de la cible du winrt ::com_ptr) et un void** (l’adresse d’un pointeur vers la cible du winrt ::com_ptr).
Exemple
winrt::com_ptr<IDXGIAdapter> adapter
...
winrt::com_ptr<IDXGIFactory2> factory;
factory.capture(adapter, &IDXGIAdapter::GetParent);
fonction com_ptr ::copy_from
Copie à partir d’un autre pointeur. Décrémente le nombre de références sur n’importe quelle interface ou objet actuellement référencé, copie le paramètre de pointeur brut et commence à gérer la durée de vie de l’interface ou de l’objet vers lequel il pointe.
Syntaxe
void copy_from(T* other) noexcept;
Paramètres
other Pointeur brut vers une cible dont la durée de vie doit être gérée par l’objet com_ptr .
fonction com_ptr ::copy_to
Copie vers un autre pointeur à partir de l’objet com_ptr . Incrémente le nombre de références sur n’importe quelle interface ou objet actuellement référencé, et copie l’adresse mémoire de l’interface ou de l’objet dans le paramètre. Cette fonction vous permet d’attribuer une référence à la même interface sans appeler QueryInterface.
Syntaxe
void copy_to(T** other) const noexcept;
Paramètres
other L’adresse brute d’un pointeur ; dans lequel copier le pointeur vers la cible de l’objet com_ptr.
fonction com_ptr ::d etach
Détache de l’interface ou de l’objet référencé sans décrémenter le nombre de références, peut-être pour le renvoyer à un appelant.
Syntaxe
T* detach() noexcept;
Valeur de retour
Pointeur vers l’interface ou l’objet référencé par l’objet com_ptr .
com_ptr ::get, fonction
Retourne le pointeur brut sous-jacent si vous devez le passer à une fonction. Vous pouvez appeler AddRef, Release ou QueryInterface sur le pointeur renvoyé.
Syntaxe
T* get() const noexcept;
Valeur de retour
Pointeur vers l’interface ou l’objet référencé par l’objet com_ptr .
fonction com_ptr ::p ut
Renvoie l’adresse du pointeur brut sous-jacent à passer à une fonction qui remplira la valeur ; Cette fonction vous permet d’appeler des méthodes (telles que des méthodes COM) qui renvoient des références en tant que paramètres de sortie via un pointeur vers un pointeur.
Syntaxe
T** put() noexcept;
Valeur de retour
Adresse du pointeur brut sous-jacent.
fonction com_ptr ::p ut_void
Renvoie l’adresse du pointeur brut sous-jacent en tant que pointeur vers un pointeur à annuler pour le transmettre à une fonction (telle que les méthodes COM) qui renvoie des références en tant que paramètres de sortie via un pointeur vers un pointeur vers void.
Syntaxe
void** put_void() noexcept;
Valeur de retour
Adresse du pointeur brut sous-jacent en tant que pointeur vers un pointeur à annuler.
fonction com_ptr ::try_as
Retourne l’interface demandée, si elle est prise en charge. Renvoie nullptr (la autosurcharge -retournée) ou false (la surcharge -retour), si ce n’est boolpas le cas. Cette fonction est utile si vous souhaitez interroger une interface que vous n’avez pas besoin de renvoyer à votre appelant.
Syntaxe
template <typename To> auto try_as() const noexcept;
template <typename To> bool try_as(To& to) const noexcept;
Paramètres de modèle
typename To Le type de l’interface demandée.
Paramètres
to Référence à une valeur pour recevoir l’interface demandée.
Valeur de retour
Un com_ptr référençant l’interface demandée, ou un pointeur intelligent fortement typé pour l’interface demandée (déclaré par C++/WinRT ou par un tiers), si l’interface demandée est prise en charge, autrement nullptr (la autosurcharge -retournée) ou false (la boolsurcharge -retournée).
fonction com_ptr ::try_capture
Une version de com_ptr ::capture qui ne lance pas en cas d’échec mais qui renvoie des retours true en cas de succès ou false d’échec.
Voir aussi le modèle de fonction winrt ::try_capture.
com_ptr ::operator bool
Vérifie si le pointeur intelligent fait référence ou non à une interface ou à un objet. Si le pointeur intelligent ne référence pas une interface ou un objet, il est logiquement null ; sinon, il n’est pas logiquement null.
Syntaxe
explicit operator bool() const noexcept;
Valeur de retour
true Si le pointeur intelligent fait référence à une interface ou à un objet (logiquement non null), sinon false (logiquement null).
com_ptr ::operator* (opérateur indirection)
Renvoie une référence à la cible de l’com_ptr afin que vous puissiez la passer à une fonction qui attend une référence au type de cible T.
Syntaxe
T& operator*() const noexcept;
Valeur de retour
Une référence à la cible du com_ptr.
com_ptr ::operator= (opérateur d’affectation)
Attribue une valeur à l’objet com_ptr .
Syntaxe
winrt::com_ptr& operator=(winrt::com_ptr const& other) noexcept;
template <typename U> winrt::com_ptr& operator=(winrt::com_ptr<U> const& other) noexcept;
template <typename U> winrt::com_ptr& operator=(winrt::com_ptr<U>&& other) noexcept;
Paramètres de modèle
typename U Type pointé par la valeur attribuée.
Paramètres
other Valeur com_ptr à attribuer à l’objet com_ptr . Le T du paramètre doit être convertible en T de l’objet com_ptr.
Valeur de retour
Référence à l’objet com_ptr .
com_ptr ::operator-> (opérateur fléché)
Pour permettre l’accès aux méthodes de l’interface référencée ou de l’objet, retourne le pointeur brut sous-jacent. Vous ne pouvez pas appeler AddRef ou Release sur le pointeur renvoyé, mais vous pouvez appeler QueryInterface.
Syntaxe
auto operator->() const noexcept;
Valeur de retour
Pointeur vers l’interface ou l’objet référencé par l’objet com_ptr .
fonction attach_abi
Attache un objet com_ptr à un pointeur brut qui possède une référence à sa cible ; Une référence supplémentaire n’est pas ajoutée. Si nécessaire, vous pouvez utiliser cette fonction pour fusionner les références.
Syntaxe
void attach_abi(winrt::com_ptr<T>& object, T* value) noexcept;
Paramètres
object Un objet com_ptr sur lequel opérer.
value Pointeur brut qui possède une référence à sa cible.
fonction detach_abi
Détache un objet com_ptr de son interface brute sans décrémenter le nombre de références, peut-être pour le renvoyer à un appelant.
Syntaxe
auto detach_abi(winrt::com_ptr<T>& object) noexcept;
Paramètres
object Un objet com_ptr sur lequel opérer.
Valeur de retour
Pointeur vers l’interface brute référencée par l’objet com_ptr .
operator != (opérateur d’inégalité)
Retourne une valeur indiquant si les deux paramètres font référence à des cibles différentes.
Syntaxe
template <typename T> bool operator!=(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
template <typename T> bool operator!=(winrt::com_ptr<T> const& left, std::nullptr_t) noexcept;
template <typename T> bool operator!=(std::nullptr_t, winrt::com_ptr<T> const& right) noexcept;
Paramètres
left
right Valeur com_ptr dont l’adresse mémoire de la cible doit être comparée à celle de l’autre paramètre.
Valeur de retour
true Si les deux paramètres pointent vers des cibles différentes, sinon false.
opérateur< (inférieur à opérateur)
Retourne une valeur indiquant si la cible du premier paramètre se produit plus tôt en mémoire que celle du deuxième paramètre.
Syntaxe
template <typename T> bool operator<(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
Paramètres
left
right Valeur com_ptr dont l’adresse mémoire de la cible doit être comparée à celle de l’autre paramètre.
Valeur de retour
true Si l’adresse mémoire de la cible du premier paramètre est inférieure à celle du second paramètre, sinon false.
operator<= (opérateur inférieur ou égal à)
Retourne une valeur indiquant si la cible du premier paramètre se produit plus tôt en mémoire que, ou au même emplacement que celui du deuxième paramètre.
Syntaxe
template <typename T> bool operator<=(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
Paramètres
left
right Valeur com_ptr dont l’adresse mémoire de la cible doit être comparée à celle de l’autre paramètre.
Valeur de retour
true Si l’adresse mémoire de la cible du premier paramètre est inférieure ou égale à celle du second paramètre, sinon false.
operator== (opérateur d’égalité)
Retourne une valeur indiquant si les deux paramètres font référence à la même interface et/ou à l’objet.
Syntaxe
template <typename T> bool operator==(winrt::com_ptr<T> const& left, std::nullptr_t) noexcept;
template <typename T> bool operator==(std::nullptr_t, winrt::com_ptr<T> const& right) noexcept;
Paramètres
left
right Valeur com_ptr dont l’adresse mémoire de la cible doit être comparée à celle de l’autre paramètre.
Valeur de retour
true Si les deux paramètres pointent vers la même cible, sinon false.
opérateur> (opérateur supérieur à)
Retourne une valeur indiquant si la cible du premier paramètre se produit plus tard dans la mémoire que celle du deuxième paramètre.
Syntaxe
template <typename T> bool operator>(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
Paramètres
left
right Valeur com_ptr dont l’adresse mémoire de la cible doit être comparée à celle de l’autre paramètre.
Valeur de retour
true Si l’adresse mémoire de la cible du premier paramètre est supérieure à celle du second paramètre, sinon false.
operator>= (opérateur supérieur ou égal à)
Retourne une valeur indiquant si la cible du premier paramètre se produit plus tard dans la mémoire que, ou au même emplacement que celui du deuxième paramètre.
Syntaxe
template <typename T> bool operator>=(winrt::com_ptr<T> const& left, winrt::com_ptr<T> const& right) noexcept;
Paramètres
left
right Valeur com_ptr dont l’adresse mémoire de la cible doit être comparée à celle de l’autre paramètre.
Valeur de retour
true Si l’adresse mémoire de la cible du premier paramètre est supérieure ou égale à celle du second paramètre, dans le cas contraire false, .
swap, fonction
Permute le contenu des deux paramètres de com_ptr afin qu’ils pointent vers la cible de l’autre.
Syntaxe
void swap(winrt::com_ptr& left, winrt::com_ptr& right) noexcept;
Paramètres
left
right Une valeur com_ptr dont le pointeur s’échange mutuellement avec celui de l’autre paramètre.