auto_gcroot, classe

Article
10/12/2023

Gestion automatique des ressources (comme auto_ptr Classe) qui peut être utilisée pour incorporer un handle virtuel dans un type natif.

Syntaxe

template<typename _element_type>
class auto_gcroot;

Paramètres

_element_type
Type managé à incorporer.

Membres

Constructeurs publics

Nom	Description
auto_gcroot::auto_gcroot	Constructeur `auto_gcroot`.
auto_gcroot::~auto_gcroot	Destructeur `auto_gcroot` .

Méthodes publiques

Nom	Description
auto_gcroot::attach	Attacher `auto_gcroot` à un objet.
auto_gcroot::get	Obtient l’objet contenu.
auto_gcroot::release	Libère l’objet de `auto_gcroot` la gestion.
auto_gcroot::reset	Détruisez l’objet détenu actuel et prenez éventuellement possession d’un nouvel objet.
auto_gcroot::swap	Échange des objets avec un autre `auto_gcroot`.

Opérateurs publics

Nom	Description
`auto_gcroot::operator->`	Opérateur d’accès membre.
auto_gcroot::operator=	Opérateur d'assignation.
auto_gcroot::operator auto_gcroot	Opérateur de cast de type entre `auto_gcroot` les types compatibles.
auto_gcroot::operator bool	Opérateur à utiliser `auto_gcroot` dans une expression conditionnelle.
auto_gcroot::operator!	Opérateur à utiliser `auto_gcroot` dans une expression conditionnelle.

Spécifications

Fichier d’en-tête<msclr\auto_gcroot.h>

Espace de noms msclr

auto_gcroot::auto_gcroot

Constructeur auto_gcroot.

auto_gcroot(
   _element_type _ptr = nullptr
);
auto_gcroot(
   auto_gcroot<_element_type> & _right
);
template<typename _other_type>
auto_gcroot(
   auto_gcroot<_other_type> & _right
);

Paramètres

_ptr
Objet à posséder.

_Droite
auto_gcroot existant.

Notes

Lors de la construction d’un auto_gcroot objet existant auto_gcroot, l’existant auto_gcroot libère son objet avant de transférer la propriété de l’objet vers le nouveau auto_gcroot.

Exemple

// msl_auto_gcroot_auto_gcroot.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

ref class RefClassA {
protected:
   String^ m_s;
public:
   RefClassA(String^ s) : m_s(s) {
      Console::WriteLine( "in RefClassA constructor: " + m_s );
   }
   ~RefClassA() {
      Console::WriteLine( "in RefClassA destructor: " + m_s );
   }

   virtual void PrintHello() {
      Console::WriteLine( "Hello from {0} A!", m_s );
   }
};

ref class RefClassB : RefClassA {
public:
   RefClassB( String^ s ) : RefClassA( s ) {}
   virtual void PrintHello() new {
      Console::WriteLine( "Hello from {0} B!", m_s );
   }
};

class ClassA { //unmanaged class
private:
   auto_gcroot<RefClassA^> m_a;

public:
   ClassA() : m_a( gcnew RefClassA( "unmanaged" ) ) {}
   ~ClassA() {} //no need to delete m_a

   void DoSomething() {
      m_a->PrintHello();
   }
};

int main()
{
   {
      ClassA a;
      a.DoSomething();
   } // a.m_a is automatically destroyed as a goes out of scope

   {
      auto_gcroot<RefClassA^> a(gcnew RefClassA( "first" ) );
      a->PrintHello();
   }

   {
      auto_gcroot<RefClassB^> b(gcnew RefClassB( "second" ) );
      b->PrintHello();
      auto_gcroot<RefClassA^> a(b); //construct from derived type
      a->PrintHello();
      auto_gcroot<RefClassA^> a2(a); //construct from same type
      a2->PrintHello();
   }

   Console::WriteLine("done");
}

in RefClassA constructor: unmanaged
Hello from unmanaged A!
in RefClassA destructor: unmanaged
in RefClassA constructor: first
Hello from first A!
in RefClassA destructor: first
in RefClassA constructor: second
Hello from second B!
Hello from second A!
Hello from second A!
in RefClassA destructor: second
done

auto_gcroot::~auto_gcroot

Destructeur auto_gcroot .

~auto_gcroot();

Notes

Le destructeur détruit également l’objet appartenant.

Exemple

// msl_auto_gcroot_dtor.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

ref class ClassA {
public:
   ClassA() { Console::WriteLine( "ClassA constructor" ); }
   ~ClassA() { Console::WriteLine( "ClassA destructor" ); }
};

int main()
{
   // create a new scope for a:
   {
      auto_gcroot<ClassA^> a = gcnew ClassA;
   }
   // a goes out of scope here, invoking its destructor
   // which in turns destructs the ClassA object.

   Console::WriteLine( "done" );
}

ClassA constructor
ClassA destructor
done

auto_gcroot::attach

Attacher auto_gcroot à un objet.

auto_gcroot<_element_type> & attach(
   _element_type _right
);
auto_gcroot<_element_type> & attach(
   auto_gcroot<_element_type> & _right
);
template<typename _other_type>
auto_gcroot<_element_type> & attach(
   auto_gcroot<_other_type> & _right
);

Paramètres

_Droite
Objet à attacher ou auto_gcroot contenant l’objet à attacher.

Valeur retournée

auto_gcroot actuel.

Notes

S’il _right s’agit d’un auto_gcroot, il libère la propriété de son objet avant que l’objet soit attaché à l’objet actuel auto_gcroot.

Exemple

// msl_auto_gcroot_attach.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

ref class ClassA {
protected:
   String^ m_s;
public:
   ClassA( String^ s ) : m_s( s ) {
      Console::WriteLine( "in ClassA constructor:" + m_s );
   }
   ~ClassA() {
      Console::WriteLine( "in ClassA destructor:" + m_s );
   }

   virtual void PrintHello() {
      Console::WriteLine( "Hello from {0} A!", m_s );
   }
};

ref class ClassB : ClassA {
public:
   ClassB( String ^ s) : ClassA( s ) {}
   virtual void PrintHello() new {
      Console::WriteLine( "Hello from {0} B!", m_s );
   }
};

int main() {
   auto_gcroot<ClassA^> a( gcnew ClassA( "first" ) );
   a->PrintHello();
   a.attach( gcnew ClassA( "second" ) ); // attach same type
   a->PrintHello();
   ClassA^ ha = gcnew ClassA( "third" );
   a.attach( ha ); // attach raw handle
   a->PrintHello();
   auto_gcroot<ClassB^> b( gcnew ClassB("fourth") );
   b->PrintHello();
   a.attach( b ); // attach derived type
   a->PrintHello();
}

in ClassA constructor:first
Hello from first A!
in ClassA constructor:second
in ClassA destructor:first
Hello from second A!
in ClassA constructor:third
in ClassA destructor:second
Hello from third A!
in ClassA constructor:fourth
Hello from fourth B!
in ClassA destructor:third
Hello from fourth A!
in ClassA destructor:fourth

auto_gcroot::get

Obtient l’objet contenu.

_element_type get() const;

Valeur retournée

Objet contenu.

Exemple

// msl_auto_gcroot_get.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

ref class ClassA {
   String^ m_s;
public:
   ClassA( String^ s ) : m_s( s ){
      Console::WriteLine( "in ClassA constructor:" + m_s );
   }
   ~ClassA() {
      Console::WriteLine( "in ClassA destructor:" + m_s );
   }

   void PrintHello() {
      Console::WriteLine( "Hello from {0} A!", m_s );
   }
};

void PrintA( ClassA^ a ) {
   a->PrintHello();
}

int main() {
   auto_gcroot<ClassA^> a = gcnew ClassA( "first" );
   a->PrintHello();

   ClassA^ a2 = a.get();
   a2->PrintHello();

   PrintA( a.get() );
}

in ClassA constructor:first
Hello from first A!
Hello from first A!
Hello from first A!
in ClassA destructor:first

auto_gcroot::release

Libère l’objet de auto_gcroot la gestion.

_element_type release();

Valeur retournée

Objet libéré.

Exemple

// msl_auto_gcroot_release.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

ref class ClassA {
   String^ m_s;
public:
   ClassA( String^ s ) : m_s( s ) {
      Console::WriteLine( "ClassA constructor: " + m_s );
   }
   ~ClassA() {
      Console::WriteLine( "ClassA destructor: " + m_s );
   }

   void PrintHello() {
      Console::WriteLine( "Hello from {0} A!", m_s );
   }
};

int main()
{
   ClassA^ a;

   // create a new scope:
   {
      auto_gcroot<ClassA^> agc1 = gcnew ClassA( "first" );
      auto_gcroot<ClassA^> agc2 = gcnew ClassA( "second" );
      a = agc1.release();
   }
   // agc1 and agc2 go out of scope here

   a->PrintHello();

   Console::WriteLine( "done" );
}

ClassA constructor: first
ClassA constructor: second
ClassA destructor: second
Hello from first A!
done

auto_gcroot::reset

Détruisez l’objet détenu actuel et prenez éventuellement possession d’un nouvel objet.

void reset(
   _element_type _new_ptr = nullptr
);

Paramètres

_new_ptr
(Facultatif) Nouvel objet.

Exemple

// msl_auto_gcroot_reset.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

ref class ClassA {
   String^ m_s;
public:
   ClassA( String^ s ) : m_s( s ) {
      Console::WriteLine( "ClassA constructor: " + m_s );
   }
   ~ClassA() {
      Console::WriteLine( "ClassA destructor: " + m_s );
   }

   void PrintHello() {
      Console::WriteLine( "Hello from {0} A!", m_s );
   }
};

int main()
{
   auto_gcroot<ClassA^> agc1 = gcnew ClassA( "first" );
   agc1->PrintHello();

   ClassA^ ha = gcnew ClassA( "second" );
   agc1.reset( ha ); // release first object, reference second
   agc1->PrintHello();

   agc1.reset(); // release second object, set to nullptr

   Console::WriteLine( "done" );
}

ClassA constructor: first
Hello from first A!
ClassA constructor: second
ClassA destructor: first
Hello from second A!
ClassA destructor: second
done

auto_gcroot::swap

Échange des objets avec un autre auto_gcroot.

void swap(
   auto_gcroot<_element_type> & _right
);

Paramètres

_Droite
auto_gcroot Avec lequel échanger des objets.

Exemple

// msl_auto_gcroot_swap.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

int main() {
   auto_gcroot<String^> s1 = "string one";
   auto_gcroot<String^> s2 = "string two";

   Console::WriteLine( "s1 = '{0}', s2 = '{1}'",
      s1->ToString(), s2->ToString() );
   s1.swap( s2 );
   Console::WriteLine( "s1 = '{0}', s2 = '{1}'",
      s1->ToString(), s2->ToString() );
}

s1 = 'string one', s2 = 'string two'
s1 = 'string two', s2 = 'string one'

`auto_gcroot::operator->`

Opérateur d’accès membre.

_element_type operator->() const;

Valeur retournée

Objet encapsulé par auto_gcroot.

Exemple

// msl_auto_gcroot_op_arrow.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

ref class ClassA {
protected:
   String^ m_s;
public:
   ClassA( String^ s ) : m_s( s ) {}

   virtual void PrintHello() {
      Console::WriteLine( "Hello from {0} A!", m_s );
   }

   int m_i;
};

int main() {
   auto_gcroot<ClassA^> a( gcnew ClassA( "first" ) );
   a->PrintHello();

   a->m_i = 5;
   Console::WriteLine( "a->m_i = {0}", a->m_i );
}

Hello from first A!
a->m_i = 5

auto_gcroot::operator=

Opérateur d'assignation.

auto_gcroot<_element_type> & operator=(
   _element_type _right
);
auto_gcroot<_element_type> & operator=(
   auto_gcroot<_element_type> & _right
);
template<typename _other_type>
auto_gcroot<_element_type> & operator=(
   auto_gcroot<_other_type> & _right
);

Paramètres

_Droite
Objet ou auto_gcroot à affecter à l’objet actif auto_gcroot.

Valeur retournée

Le courant auto_gcroot, maintenant propriétaire _right.

Exemple

// msl_auto_gcroot_operator_equals.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

ref class ClassA {
protected:
   String^ m_s;
public:
   ClassA(String^ s) : m_s(s) {
      Console::WriteLine( "in ClassA constructor: " + m_s );
   }
   ~ClassA() {
      Console::WriteLine( "in ClassA destructor: " + m_s );
   }

   virtual void PrintHello() {
      Console::WriteLine( "Hello from {0} A!", m_s );
   }
};

ref class ClassB : ClassA {
public:
   ClassB( String^ s ) : ClassA( s ) {}
   virtual void PrintHello() new {
      Console::WriteLine( "Hello from {0} B!", m_s );
   }
};

int main()
{
   auto_gcroot<ClassA^> a;
   auto_gcroot<ClassA^> a2(gcnew ClassA( "first" ) );
   a = a2; // assign from same type
   a->PrintHello();

   ClassA^ ha = gcnew ClassA( "second" );
   a = ha; // assign from raw handle

   auto_gcroot<ClassB^> b(gcnew ClassB( "third" ) );
   b->PrintHello();
   a = b; // assign from derived type
   a->PrintHello();

   Console::WriteLine("done");
}

in ClassA constructor: first
Hello from first A!
in ClassA constructor: second
in ClassA destructor: first
in ClassA constructor: third
Hello from third B!
in ClassA destructor: second
Hello from third A!
done
in ClassA destructor: third

auto_gcroot::operator auto_gcroot

Opérateur de cast de type entre auto_gcroot les types compatibles.

template<typename _other_type>
operator auto_gcroot<_other_type>();

Valeur retournée

Cast actuel auto_gcroot sur auto_gcroot<_other_type>.

Exemple

// msl_auto_gcroot_op_auto_gcroot.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

ref class ClassA {
protected:
   String^ m_s;
public:
   ClassA( String^ s ) : m_s( s ) {}

   virtual void PrintHello() {
      Console::WriteLine( "Hello from {0} A!", m_s );
   }
};

ref class ClassB : ClassA {
public:
   ClassB( String ^ s) : ClassA( s ) {}
   virtual void PrintHello() new {
      Console::WriteLine( "Hello from {0} B!", m_s );
   }
};

int main() {
   auto_gcroot<ClassB^> b = gcnew ClassB("first");
   b->PrintHello();
   auto_gcroot<ClassA^> a = (auto_gcroot<ClassA^>)b;
   a->PrintHello();
}

Hello from first B!
Hello from first A!

auto_gcroot::operator bool

Opérateur à utiliser auto_gcroot dans une expression conditionnelle.

operator bool() const;

Valeur retournée

true si l’objet encapsulé est valide ; false autrement.

Notes

Cet opérateur se _detail_class::_safe_boolconvertit en , ce qui est plus sûr que bool parce qu’il ne peut pas être converti en type intégral.

Exemple

// msl_auto_gcroot_operator_bool.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

int main() {
   auto_gcroot<String^> s;
   if ( s ) Console::WriteLine( "s is valid" );
   if ( !s ) Console::WriteLine( "s is invalid" );
   s = "something";
   if ( s ) Console::WriteLine( "now s is valid" );
   if ( !s ) Console::WriteLine( "now s is invalid" );
   s.reset();
   if ( s ) Console::WriteLine( "now s is valid" );
   if ( !s ) Console::WriteLine( "now s is invalid" );
}

s is invalid
now s is valid
now s is invalid

auto_gcroot::operator!

Opérateur à utiliser auto_gcroot dans une expression conditionnelle.

bool operator!() const;

Valeur retournée

true si l’objet encapsulé n’est pas valide ; false autrement.

Exemple

// msl_auto_gcroot_operator_not.cpp
// compile with: /clr
#include <msclr\auto_gcroot.h>

using namespace System;
using namespace msclr;

int main() {
   auto_gcroot<String^> s;
   if ( s ) Console::WriteLine( "s is valid" );
   if ( !s ) Console::WriteLine( "s is invalid" );
   s = "something";
   if ( s ) Console::WriteLine( "now s is valid" );
   if ( !s ) Console::WriteLine( "now s is invalid" );
   s.reset();
   if ( s ) Console::WriteLine( "now s is valid" );
   if ( !s ) Console::WriteLine( "now s is invalid" );
}

s is invalid
now s is valid
now s is invalid

Partager via

auto_gcroot, classe

Syntaxe

Paramètres

Membres

Constructeurs publics

Méthodes publiques

Opérateurs publics

Spécifications

auto_gcroot::auto_gcroot

Paramètres

Notes

Exemple

auto_gcroot::~auto_gcroot

Notes

Exemple

auto_gcroot::attach

Paramètres

Valeur retournée

Notes

Exemple

auto_gcroot::get

Valeur retournée

Exemple

auto_gcroot::release

Valeur retournée

Exemple

auto_gcroot::reset

Paramètres

Exemple

auto_gcroot::swap

Paramètres

Exemple

auto_gcroot::operator->

Valeur retournée

Exemple

auto_gcroot::operator=

Paramètres

Valeur retournée

Exemple

auto_gcroot::operator auto_gcroot

Valeur retournée

Exemple

auto_gcroot::operator bool

Valeur retournée

Notes

Exemple

auto_gcroot::operator!

Valeur retournée

Exemple

Commentaires

Ressources supplémentaires

`auto_gcroot::operator->`