auto_gcroot クラス

[アーティクル]
04/03/2023

仮想ハンドルをネイティブ型に埋め込むために使用できる自動リソース管理 (Auto_ptr クラスなど)。

構文

template<typename _element_type>
class auto_gcroot;

パラメーター

_element_type
埋め込まれるマネージド型。

メンバー

パブリックコンストラクター

名前	説明
auto_gcroot::auto_gcroot	`auto_gcroot` コンストラクター。
auto_gcroot::~auto_gcroot	`auto_gcroot` デストラクター。

パブリックメソッド

名前	説明
auto_gcroot::attach	`auto_gcroot` をオブジェクトにアタッチします。
auto_gcroot::get	格納されているオブジェクトを取得します。
auto_gcroot::release	オブジェクトを `auto_gcroot` 管理から解放します。
auto_gcroot::reset	現在の所有オブジェクトを破棄し、必要に応じて新しいオブジェクトを所有します。
auto_gcroot::swap	オブジェクトを別の `auto_gcroot` とスワップします。

パブリック演算子

名前	説明
`auto_gcroot::operator->`	メンバーアクセス演算子。
auto_gcroot::operator=	代入演算子。
auto_gcroot::operator auto_gcroot	`auto_gcroot` と互換性のある型との間での型キャスト演算子。
auto_gcroot::operator bool	条件式で `auto_gcroot` を使用するための演算子。
auto_gcroot::operator!	条件式で `auto_gcroot` を使用するための演算子。

要件

ヘッダーファイル<msclr\auto_gcroot.h>

名前空間 msclr

auto_gcroot::auto_gcroot

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
);

パラメーター

_ptr
所有するオブジェクト。

_right
既存の auto_gcroot。

解説

既存の auto_gcroot から auto_gcroot を構築する場合、既存の auto_gcroot は、オブジェクトの所有権を新しい auto_gcroot に移す前に、そのオブジェクトを解放します。

例

// 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

auto_gcroot デストラクター。

~auto_gcroot();

解説

デストラクターは、所有オブジェクトも破棄します。

例

// 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

auto_gcroot をオブジェクトにアタッチします。

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
);

パラメーター

_right
アタッチするオブジェクト、またはアタッチするオブジェクトを格納している auto_gcroot。

戻り値

現在の auto_gcroot です。

解説

_right が auto_gcroot の場合は、オブジェクトが現在の auto_gcroot にアタッチされる前に、オブジェクトの所有権が解放されます。

例

// 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

格納されているオブジェクトを取得します。

_element_type get() const;

戻り値

格納されるオブジェクトです。

例

// 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

オブジェクトを auto_gcroot 管理から解放します。

_element_type release();

戻り値

解放されたオブジェクト。

例

// 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

現在の所有オブジェクトを破棄し、必要に応じて新しいオブジェクトを所有します。

void reset(
   _element_type _new_ptr = nullptr
);

パラメーター

_new_ptr
(省略可能) 新しいオブジェクト。

例

// 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

オブジェクトを別の auto_gcroot とスワップします。

void swap(
   auto_gcroot<_element_type> & _right
);

パラメーター

_right
オブジェクトのスワップに使用する auto_gcroot。

例

// 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->`

メンバーアクセス演算子。

_element_type operator->() const;

戻り値

auto_gcroot によってラップされたオブジェクト。

例

// 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=

代入演算子。

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
);

パラメーター

_right
現在の auto_gcroot に割り当てられるオブジェクトまたは auto_gcroot。

戻り値

現在 _right を所有している、現在の auto_gcroot。

例

// 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

auto_gcroot と互換性のある型との間での型キャスト演算子。

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

戻り値

auto_gcroot<_other_type> への現在の auto_gcroot キャスト。

例

// 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

条件式で auto_gcroot を使用するための演算子。

operator bool() const;

戻り値

ラップされたオブジェクトが有効な場合は true。それ以外の場合は false。

解説

この演算子は、整数型に変換できないため、実際には bool より安全な _detail_class::_safe_bool に変換されます。

例

// 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!

条件式で auto_gcroot を使用するための演算子。

bool operator!() const;

戻り値

ラップされたオブジェクトが無効な場合は true。それ以外の場合は false。

例

// 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

次の方法で共有

auto_gcroot クラス

構文

パラメーター

メンバー

パブリック コンストラクター

パブリック メソッド

パブリック演算子

要件

auto_gcroot::auto_gcroot

パラメーター

解説

例

auto_gcroot::~auto_gcroot

解説

例

auto_gcroot::attach

パラメーター

戻り値

解説

例

auto_gcroot::get

戻り値

例

auto_gcroot::release

戻り値

例

auto_gcroot::reset

パラメーター

例

auto_gcroot::swap

パラメーター

例

auto_gcroot::operator->

戻り値

例

auto_gcroot::operator=

パラメーター

戻り値

例

auto_gcroot::operator auto_gcroot

戻り値

例

auto_gcroot::operator bool

戻り値

解説

例

auto_gcroot::operator!

戻り値

例

フィードバック

その他のリソース

パブリックコンストラクター

パブリックメソッド

`auto_gcroot::operator->`