Click to Rate and Give Feedback
MSDN
MSDN Library
Visual Studio 2005
Visual Studio
Visual C++
Reference
Libraries Reference
ATL
Classes
CComPtr Class

  Switch on low bandwidth view
This page is specific to
Microsoft Visual Studio 2005/.NET Framework 2.0

Other versions are also available for the following:
ATL Library Reference 
CComPtr Class 

A smart pointer class for managing COM interface pointers.

template<
   class T 
>
class CComPtr

Parameters

T

A COM interface specifying the type of pointer to be stored.

ATL uses CComPtr and CComQIPtr to manage COM interface pointers. Both are derived from CComPtrBase, and both perform automatic reference counting.

The CComPtr and CComQIPtr classes can help eliminate memory leaks by performing automatic reference counting. The following functions both perform the same logical operations; however, note how the second version may be less error-prone by using the CComPtr class:

// Error-checking routine that performs manual lifetime management
// of a COM IErrorInfo object
HRESULT CheckComError_Manual()
{
   HRESULT hr;
   CComBSTR bstrDescription; 
   CComBSTR bstrSource; 
   CComBSTR bstrHelpFile; 

   IErrorInfo* pErrInfo = NULL; // naked COM interface pointer
   hr = ::GetErrorInfo( 0, &pErrInfo );
   if( hr != S_OK )
      return hr;

   hr = pErrInfo->GetDescription( &bstrDescription ); 
   if( FAILED( hr ) )
   {
      pErrInfo->Release();   // must release interface pointer before returning
      return hr;
   }
   hr = pErrInfo->GetSource( &bstrSource );
   if( FAILED( hr ) )
   {
      pErrInfo->Release();   // must release interface pointer before returning
      return hr;
   }
   hr = pErrInfo->GetHelpFile( &bstrHelpFile );
   if( FAILED( hr ) )
   {
      pErrInfo->Release();   // must release interface pointer before returning
      return hr;
   }

   pErrInfo->Release();      // must release interface pointer before returning
   return S_OK;
}
// Error-checking routine that performs automatic lifetime management
// of a COM IErrorInfo object through a CComPtr smart pointer object
HRESULT CheckComError_SmartPtr()
{
   HRESULT hr;
   CComBSTR bstrDescription; 
   CComBSTR bstrSource; 
   CComBSTR bstrHelpFile; 

   CComPtr<IErrorInfo> pErrInfo; 
   hr = ::GetErrorInfo( 0, &pErrInfo );
   if( hr != S_OK )
      return hr;

   hr = pErrInfo->GetDescription( &bstrDescription ); 
   if( FAILED( hr ) )
      return hr;
   hr = pErrInfo->GetSource( &bstrSource );
   if( FAILED( hr ) )
      return hr;
   hr = pErrInfo->GetHelpFile( &bstrHelpFile );
   if( FAILED( hr ) )
      return hr;

   return S_OK;
}   // CComPtr will auto-release underlying IErrorInfo interface pointer as needed

In Debug builds, link atlsd.lib for code tracing.

Header: atlbase.h

Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker