msclr::auto_gcroot< _element_type > Class Template Reference

#include <msclr/auto_gcroot.h>

Public Member Functions
	auto_gcroot (_element_type _ptr=nullptr)
	auto_gcroot (auto_gcroot< _element_type > &_right)
	auto_gcroot (_detail::_auto_gcroot_ref< _element_type > _right)
template<typename _other_type >
	auto_gcroot (auto_gcroot< _other_type > &_right)
auto_gcroot< _element_type > &	attach (_element_type _right)
auto_gcroot< _element_type > &	attach (auto_gcroot< _element_type > &_right)
auto_gcroot< _element_type > &	attach (_detail::_auto_gcroot_ref< _element_type > &_right)
template<typename _other_type >
auto_gcroot< _element_type > &	attach (auto_gcroot< _other_type > &_right)
auto_gcroot< _element_type > &	operator= (_element_type _right)
auto_gcroot< _element_type > &	operator= (auto_gcroot< _element_type > &_right)
auto_gcroot< _element_type > &	operator= (_detail::_auto_gcroot_ref< _element_type > &_right)
template<typename _other_type >
auto_gcroot< _element_type > &	operator= (auto_gcroot< _other_type > &_right)
_element_type	get () const
_element_type	operator-> () const
	operator _detail_class::_safe_bool () const
bool	operator! () const
	operator _detail::_auto_gcroot_ref< _element_type > ()
template<typename _other_type >
	operator auto_gcroot< _other_type > ()
template<typename _other_type >
	operator _detail::_auto_gcroot_ref< _other_type > ()
void	swap (auto_gcroot< _element_type > &_right)
void	reset (_element_type _new_ptr=nullptr)
_element_type	release ()
	~auto_gcroot ()

Private Member Functions
bool	operator== (_detail_class::_safe_bool) const
bool	operator!= (_detail_class::_safe_bool) const
bool	valid () const

Private Attributes
gcroot< _element_type >	m_ptr

Constructor & Destructor Documentation

template<typename _element_type>

msclr::auto_gcroot< _element_type >::auto_gcroot ( _element_type  _ptr = nullptr )

inline

        : m_ptr( _ptr )
    {
    }

template<typename _element_type>

msclr::auto_gcroot< _element_type >::auto_gcroot ( auto_gcroot< _element_type > &  _right )

inline

            : m_ptr( _right.release() )
    {
    }

template<typename _element_type>

msclr::auto_gcroot< _element_type >::auto_gcroot ( _detail::_auto_gcroot_ref< _element_type >  _right )

inline

        : m_ptr( _right.m_ref.release() )
    {
    }

template<typename _element_type>

template<typename _other_type >

msclr::auto_gcroot< _element_type >::auto_gcroot ( auto_gcroot< _other_type > &  _right )

inline

        : m_ptr( _right.release() )
    {
    }

template<typename _element_type>

msclr::auto_gcroot< _element_type >::~auto_gcroot ( )

inline

    {
        if( valid() )
        {
            delete _element_type(m_ptr);
        }
    }

Member Function Documentation

template<typename _element_type>

auto_gcroot<_element_type>& msclr::auto_gcroot< _element_type >::attach ( _element_type  _right )

inline

    {
        reset(_right);
        return *this;
    }

template<typename _element_type>

auto_gcroot<_element_type>& msclr::auto_gcroot< _element_type >::attach ( auto_gcroot< _element_type > &  _right )

inline

    {
        reset( _right.release() );
        return *this;
    }

template<typename _element_type>

auto_gcroot<_element_type>& msclr::auto_gcroot< _element_type >::attach ( _detail::_auto_gcroot_ref< _element_type > &  _right )

inline

    {
        reset( _right.m_ref.release() );
        return *this;
    }

template<typename _element_type>

template<typename _other_type >

auto_gcroot<_element_type>& msclr::auto_gcroot< _element_type >::attach ( auto_gcroot< _other_type > &  _right )

inline

    {
        reset( _right.release() );
        return *this;
    }

template<typename _element_type>

_element_type msclr::auto_gcroot< _element_type >::get ( ) const

inline

    {
        return m_ptr;
    }

template<typename _element_type>

msclr::auto_gcroot< _element_type >::operator _detail::_auto_gcroot_ref< _element_type > ( )

inline

    {
        return _detail::_auto_gcroot_ref<_element_type>( *this );
    }

template<typename _element_type>

template<typename _other_type >

msclr::auto_gcroot< _element_type >::operator _detail::_auto_gcroot_ref< _other_type > ( )

inline

    {
        return _detail::_auto_gcroot_ref<_other_type>( *this );
    }

template<typename _element_type>

msclr::auto_gcroot< _element_type >::operator _detail_class::_safe_bool ( ) const

inline

    {
        return valid() ? _detail_class::_safe_true : _detail_class::_safe_false;
    }

template<typename _element_type>

template<typename _other_type >

msclr::auto_gcroot< _element_type >::operator auto_gcroot< _other_type > ( )

inline

    {
        return auto_gcroot<_other_type>( *this );
    }

template<typename _element_type>

bool msclr::auto_gcroot< _element_type >::operator! ( ) const

inline

    {
        return ! valid();
    }

template<typename _element_type>

bool msclr::auto_gcroot< _element_type >::operator!= ( _detail_class::_safe_bool  ) const

private

template<typename _element_type>

_element_type msclr::auto_gcroot< _element_type >::operator-> ( ) const

inline

    {
        return m_ptr;
    }

template<typename _element_type>

auto_gcroot<_element_type>& msclr::auto_gcroot< _element_type >::operator= ( _element_type  _right )

inline

    {
        return attach(_right);
    }

template<typename _element_type>

auto_gcroot<_element_type>& msclr::auto_gcroot< _element_type >::operator= ( auto_gcroot< _element_type > &  _right )

inline

    {
        return attach(_right);
    }

template<typename _element_type>

auto_gcroot<_element_type>& msclr::auto_gcroot< _element_type >::operator= ( _detail::_auto_gcroot_ref< _element_type > &  _right )

inline

    {
        return attach(_right);
    }

template<typename _element_type>

template<typename _other_type >

auto_gcroot<_element_type>& msclr::auto_gcroot< _element_type >::operator= ( auto_gcroot< _other_type > &  _right )

inline

    {
        return attach(_right);
    }

template<typename _element_type>

bool msclr::auto_gcroot< _element_type >::operator== ( _detail_class::_safe_bool  ) const

private

template<typename _element_type>

_element_type msclr::auto_gcroot< _element_type >::release ( )

inline

    {
        _element_type _tmp_ptr = m_ptr;
        m_ptr = nullptr;
        return _tmp_ptr;
    }

template<typename _element_type>

void msclr::auto_gcroot< _element_type >::reset ( _element_type  _new_ptr = nullptr )

inline

    {
        if( _element_type(m_ptr) != _new_ptr )
        {
            if( valid() )
            {
                delete _element_type(m_ptr);
            }
            m_ptr = _new_ptr;
        }
    }

template<typename _element_type>

void msclr::auto_gcroot< _element_type >::swap ( auto_gcroot< _element_type > &  _right )

inline

    {
        m_ptr.swap( _right.m_ptr );
    }

template<typename _element_type>

bool msclr::auto_gcroot< _element_type >::valid ( ) const

inlineprivate

    {
        // see if the managed resource is in the invalid state.
        return _element_type(m_ptr) != nullptr;
    }

Member Data Documentation

template<typename _element_type>

gcroot<_element_type> msclr::auto_gcroot< _element_type >::m_ptr

private

---

The documentation for this class was generated from the following file:

• VS2015/inc/msclr/auto_gcroot.h