msclr::com::ptr< _interface_type > Class Template Reference

#include <msclr/com/ptr.h>

Public Member Functions
	ptr ()
	ptr (_interface_type *p)
void	Attach (_interface_type *_right)
ptr< _interface_type >	operator= (_interface_type *_right)
void	CreateInstance (System::String^prog_id, LPUNKNOWN pouter, DWORD cls_context)
void	CreateInstance (System::String^prog_id, LPUNKNOWN pouter)
void	CreateInstance (System::String^prog_id)
void	CreateInstance (const wchar_t *progid, LPUNKNOWN pouter, DWORD cls_context)
void	CreateInstance (const wchar_t *progid, LPUNKNOWN pouter)
void	CreateInstance (const wchar_t *progid)
void	CreateInstance (REFCLSID rclsid, LPUNKNOWN pouter, DWORD cls_context)
void	CreateInstance (REFCLSID rclsid, LPUNKNOWN pouter)
void	CreateInstance (REFCLSID rclsid)
_interface_type *	Detach ()
void	Release ()
_detail::smart_com_ptr< _interface_type >	operator-> ()
_interface_type *	GetInterface ()
template<class _other_type >
void	QueryInterface (ptr< _other_type >%other)
	operator _detail_class::_safe_bool ()
bool	operator! ()
	~ptr ()

Private Member Functions
void	destroy ()
bool	valid ()
void	assign (_interface_type *p)
template<class _other_type >
void	QueryInterface (REFIID riid, ptr< _other_type >%other)

Private Attributes
Object	obj_rcw

Constructor & Destructor Documentation

template<class _interface_type>

msclr::com::ptr< _interface_type >::ptr ( )

inline

             :obj_rcw(nullptr)
        {
        }

template<class _interface_type>

msclr::com::ptr< _interface_type >::ptr ( _interface_type *  p )

inline

        {
            obj_rcw = nullptr;
            assign(p);
        }

template<class _interface_type>

msclr::com::ptr< _interface_type >::~ptr ( )

inline

        {
            if(valid())
            {
                destroy();
            }
        }

Member Function Documentation

template<class _interface_type>

void msclr::com::ptr< _interface_type >::assign ( _interface_type *  p )

inlineprivate

        {
            if(p)
            {
                obj_rcw = System::Runtime::InteropServices::Marshal::GetUniqueObjectForIUnknown(System::IntPtr(p));
            }
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::Attach ( _interface_type *  _right )

inline

        {
            if (valid())
            {
                throw gcnew System::InvalidOperationException("COM::ptr.Attach");
            }

            assign(_right);
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::CreateInstance ( System::String^  prog_id, LPUNKNOWN  pouter, DWORD  cls_context  )

inline

        {
            wchar_t * pwszprog_id = NULL;

            if(prog_id != nullptr)
            {
                pin_ptr<const __wchar_t> _pinned_ptr = PtrToStringChars( prog_id );
                pwszprog_id = _wcsdup(_pinned_ptr);
            }

            try
            {
                CreateInstance(pwszprog_id, pouter, cls_context);
            }
            finally
            {
                free(pwszprog_id);
            }
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::CreateInstance ( System::String^  prog_id, LPUNKNOWN  pouter  )

inline

        {
            CreateInstance(prog_id, pouter, CLSCTX_ALL);
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::CreateInstance ( System::String^  prog_id )

inline

        {
            CreateInstance(prog_id, NULL, CLSCTX_ALL);
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::CreateInstance ( const wchar_t *  progid, LPUNKNOWN  pouter, DWORD  cls_context  )

inline

        {
            CLSID clsid;
            System::Runtime::InteropServices::Marshal::ThrowExceptionForHR(
                CLSIDFromProgID(progid, &clsid));
            CreateInstance(clsid, pouter, cls_context);
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::CreateInstance ( const wchar_t *  progid, LPUNKNOWN  pouter  )

inline

        {
            CreateInstance(progid, pouter, CLSCTX_ALL);
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::CreateInstance ( const wchar_t *  progid )

inline

        {
            CreateInstance(progid, NULL, CLSCTX_ALL);
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::CreateInstance ( REFCLSID  rclsid, LPUNKNOWN  pouter, DWORD  cls_context  )

inline

        {
            if (valid())
            {
                throw gcnew System::InvalidOperationException("COM::ptr.CreateInstance");
            }

            _interface_type * interface_ptr = NULL;

            System::Runtime::InteropServices::Marshal::ThrowExceptionForHR(CoCreateInstance(
                        rclsid, pouter, cls_context, __uuidof(_interface_type),
                        (void**)&interface_ptr));

            if (interface_ptr)
            {
                assign(interface_ptr);
                interface_ptr->Release();
            }
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::CreateInstance ( REFCLSID  rclsid, LPUNKNOWN  pouter  )

inline

        {
            CreateInstance(rclsid, pouter, CLSCTX_ALL);
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::CreateInstance ( REFCLSID  rclsid )

inline

        {
            CreateInstance(rclsid, NULL, CLSCTX_ALL);
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::destroy ( )

inlineprivate

        {
            System::Runtime::InteropServices::Marshal::ReleaseComObject(obj_rcw);
            obj_rcw = nullptr;
        }

template<class _interface_type>

_interface_type* msclr::com::ptr< _interface_type >::Detach ( )

inline

        {
            if(valid())
            {
                _interface_type * interface_ptr = GetInterface();
                destroy();
                return interface_ptr;
            }

            return NULL;
        }

template<class _interface_type>

_interface_type* msclr::com::ptr< _interface_type >::GetInterface ( )

inline

        {
            if(!valid())
            {
                return NULL;
            }

            System::IntPtr iface_intptr = System::Runtime::InteropServices::Marshal::GetIUnknownForObject(obj_rcw);

            IUnknown * iunk = static_cast<IUnknown *>(static_cast<void*>(iface_intptr));

            _interface_type * interface_ptr = NULL;
            System::Runtime::InteropServices::Marshal::ThrowExceptionForHR(iunk->QueryInterface(__uuidof(_interface_type), (void **)&interface_ptr));

            iunk->Release();

            interface_ptr->AddRef();
            System::Runtime::InteropServices::Marshal::Release(iface_intptr);

            return interface_ptr;
        }

template<class _interface_type>

msclr::com::ptr< _interface_type >::operator _detail_class::_safe_bool ( )

inline

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

template<class _interface_type>

bool msclr::com::ptr< _interface_type >::operator! ( )

inline

        {
            return ! valid();
        }

template<class _interface_type>

_detail::smart_com_ptr<_interface_type> msclr::com::ptr< _interface_type >::operator-> ( )

inline

        {
            _detail::smart_com_ptr<_interface_type> interface_ptr(GetInterface());
            return interface_ptr;
        }

template<class _interface_type>

ptr<_interface_type> msclr::com::ptr< _interface_type >::operator= ( _interface_type *  _right )

inline

        {
            Attach(_right);
            return *this;
        }

template<class _interface_type>

template<class _other_type >

void msclr::com::ptr< _interface_type >::QueryInterface ( ptr< _other_type >%  other )

inline

        {
            QueryInterface<_other_type>(__uuidof(_other_type), other);
        }

template<class _interface_type>

template<class _other_type >

void msclr::com::ptr< _interface_type >::QueryInterface ( REFIID  riid, ptr< _other_type >%  other  )

inlineprivate

        {
            _detail::smart_com_ptr<_interface_type> interface_ptr(GetInterface());
            _other_type * other_ptr = NULL;

            System::Runtime::InteropServices::Marshal::ThrowExceptionForHR(interface_ptr->QueryInterface(riid,(void **)&other_ptr));
            other.Attach(other_ptr);

            other_ptr->Release();
        }

template<class _interface_type>

void msclr::com::ptr< _interface_type >::Release ( )

inline

        {
            if(valid())
            {
                destroy();
            }
        }

template<class _interface_type>

bool msclr::com::ptr< _interface_type >::valid ( )

inlineprivate

        {
            return (obj_rcw != nullptr);
        }

Member Data Documentation

template<class _interface_type>

Object msclr::com::ptr< _interface_type >::obj_rcw

private

---

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

• VS2015/inc/msclr/com/ptr.h