正确的使用CComSafeArray,CComVariant和CComBSTR

正确的使用CComSafeArray,CComVariant和CComBSTR

如果你用C++来编写COM，那么你将必不可少的使用这三个类型。使用这三种wrapper class毫无疑问会简化我们的编程，使得使用SAFEARRAY, VARIANT和BSTR简单。但是，使用这三个类型依然需要小心，因为使用不当的话，就会造成内存泄漏，或效率降低。

1. 如果拷贝两个BSTR
假如我们一个BSTR，这个时候我希望复制一份BSTR，并丢弃之前的BSTR。通常我们会这么写：

CComBSTR StringToBSTR( const   string   &  sVal)
{
     CComBSTR bstrValue  =  sVal.data();
      return  bstrValue;
}

int  main()
{
     CComBSTR vValue  =  StringToBSTR( " value " );

      return   0 ;
}

当然，上面这个程序没有任何问题，不会有任何内存泄漏的可能。但是，你有没有上面代码里都发生了什么了？
答案很简单，在函数StringToBSTR里面，讲bstrValue返回的时候，会调用CComBSTR::Copy()，在Copy()里面将会调用
 ::SysAllocStringByteLen()
这个函数。而后在给vValue赋值的时候，又 会调用一次
::SysAllocString()
显而易见，开销很大。

那么，我们将怎么改进这段代码了？

BSTR StringToBSTR( const   string   &  sVal)
{
     CComBSTR bstrValue  =  sVal.data();
      return  bstrValue.Detach();
}

int  main()
{
     CComBSTR vValue.Attach(StringToBSTR( " value " ));

      return   0 ;
}

这样，通过CComBSTR::Detach()，我们将BSTR返回回来，通过CComBSTR::Attach()，我们将BSTR指针存储起来。这样，就减小了两次开销，大大提高了效率，也不会造成内存效率。

2. 如何使用CComSafeArray
使用CComSafeArray的一个最大的好处，就是它会自动释放元素是VARIANT和BSTR。也就是说，如果你的类型是VARIANT，它会自动调用::VariantClear()。如果你的类型是BSTR，他会自动调用::SysStringFree()方法。但是使用它的时候，同样要小心。
2.1 成对使用::SafeArrayAccessData()和::SafeArrayUnaccessData()
我们有时候会这样使用CComSafeArray的元素：

void  DoSomething()
{
     CComSafeArray < double >  pSafeArray( 3 );
      double   *  pVal  =  NULL;
     ::SafeArrayAccessData(pSafeArray . m_psa, ( void ** ) & pVal);

      // handle the elements through the pVal;
}

因为::SafeArrayAccessData 方法会在SFAEARRAY上给lock加1. 如果上面程序显示调用CComSafeArray::Destroy()函数，你检查它返回来的HRESULT的时候，应该是下面的值：
        hr    0x8002000d 内存已锁定。     HRESULT
如果你不仔细检查，那么将造成CComSafeArray没有释放。
2.2 从CComSafeArray转为成CComVariant
有时候我们使用CComVariant包装SAFEARRY。你会这样写代码：

void  DoSomething()
{
     CComSafeArray < double >  pSafeArray( 3 );
    
      // fill the safearray

     CComVariant v  =  pSafeArray.Detach();
}

你可能会任务CComVariant会存储pSafeArray的指针。可惜，你错了。
CComVariant会调用::SafeArrayCopy 来完成赋值操作。而你的pSafeArray已经调用了Detach()操作，那么它里面的SAFEARRAY就变成了孤儿，没有人去释放它了。
那么你应该怎么写了？
你可以这么写：

void  DoSomething()
{
     CComSafeArray < double >  pSafeArray( 3 );
    
      // fill the safearray

     CComVariant v  =  pSafeArray.m_psa;
}

这样，CComVariant会调用::SafeArrayCopy 来完成复制操作，而CComSafeArray也会保证在析构的时候释放里面的SAFEARRAY。

使用上面三个wrapper类，确实可以很方便我们编程，也能避免很多memory leak。但是，使用他们同样要小心，不然，同样会造成性能损失，或者，更糟糕的，内存泄漏。