BSTR

 出处：

http://baike.baidu.com/view/3346619.htm

概述

　　它被描述成一个与自动化相兼容的类型，由于 操作系统提供相应的API函数(如SysAllocString)来管理它以及一些默认的调度代码。因此BSTR实际上就是一个COM字符串，但它却在自动化技术以外的多种场合下得到广泛使用。

化学化工

　　BSTR是"Batch Stirred Tank Reactor"的缩写

　　间歇搅拌反应器

编辑本段C++

为什么需要BSTR

　　COM是一种跨编程语言的平台，需要提供语言无关的数据类型。多数编程语言有自己的字符串表示。

　　●C++ 字符串是以0结束的ASCII或Unicode字符 数组。

　　●Visual Basic字符串是一个ASCII字符数组加上表示长度的前缀。

　　●Java字符串是以0结束的Unicode字符数组。

　　需要定义一种通用的字符串类型，可以很容易的匹配到不同编程语言。 在C++中，就是BSTR。

什么是BSTR

　　BSTR是“Basic STRing”的简称， 微软在COM/OLE中定义的标准字符串数据类型。

　　对于C++，Windows头文件wtypes.h中定义如下：

　　typedef wchar_t WCHAR;

　　typedef WCHAR OLECHAR;

　　typedef OLECHAR __RPC_FAR *BSTR;;

　　使用以Null结尾的简单字符串在COM component间传递不太方便。因此， 标准BSTR是一个有长度前缀和null结束符的OLECHAR数组。BSTR的前4字节是一个表示字符串长度的前缀。BSTR长度域的值是字符串的字节数，并且不包括0结束符。

　　由于是Unicode串，所以字符数是字节数的一半。这种方式的优点是允许程序员在BSTR串中间嵌入NULL字符。但是，BSTR的前四个字节表示长度，而OLECHAR数组的前四字节表示前两个字符。这种情况下，对于C++程序，如何实现BSTR和OLECHAR的交换？答案是COM提供了两个BSTR分配用的API：SysAllocString / SysReallocString。函数返回的指针指向BSTR的第一个字符，而不是BSTR在内存的第一个字节。

什么时候使用BSTR

　　 只有在你不得不用的时候。

　　 使用BSTR一般有以下几种情况：

　　●COM interface接口定义，并且不希望额外提供custom marshaling库（MDIL生成或开发人员自己订制），必须使用BSTR传递字符串。使用C/C++类型的字符串在COM DLL传递字符串，表面上可以使用，但违背了COM的基本规则，并且给以后的扩展留下了隐患。例如，把一个In-process COM Object(简单说COM DLL)改成out-of-process object（COM EXE）。理论上， 客户端的代码应该不做任何改变。但如果是用了C/C++字符串，又希望只使用系统的automation mashaller（Oleaut32.dll），就会出错。

　　●如果可以提供custom marshaling，也推荐使用BSTR。

　　●客户要求接口必须使用BSTR，和客户讨论后，不能修改。

　　●使用的外部库的接口使用BSTR

　　 不使用的情况：

　　● 不推荐在IDL结构体中定义BSTR成员，会给结构体的复制和释放带来麻烦。最好直接使用限定最大长度的TCHAR数组。如果确实需要传递变长字符串，BSTR应该被定义成独立的参数或者使用独立的get/set接口。

　　● 尽可能缩小的BSTR及相关类型的作用域范围。类的成员变量和函数参数不使用BSTR。 局部变量要尽快释放类的内部不使用BSTR。代码处理逻辑中只在接口直接相关部分使用BSTR。接收到一个BSTR时，尽量立刻变成C/C++的字符串副本进行处理。在需要传递BSTR参数前产生BSTR，用过立即释放。

　　 字符串相关类型的推荐选择顺序

　　

优先级	类型	说明
最高	stl::string/wstring	●功能最完善，可移植性最好。
	CString	●如果编码规范限制使用STL的时候，推荐CString。 ●VC 6的版本很不完善。.Net有明显改进，需要进一步研究
	C/C++ basic type (TCHAR* / char* / LPTSTR / LPCTSTR / TCHAR[]）	●在结构体中，优先使用指定最大长度的字符数组。 ●效率最好
	CComBSTR/ _bstr_t	●在必须使用BSTR时的优先选择。 ●在ATL（COM component）工程或者工程中必须使用ATL中，优先选择CComBSTR。一般Exe/dll如果_bstr_t能满足要求，优先使用_bstr_t。 ●对于VC6，使用_bstr_t一定要慎重，最好只用作简单临时变量保存调被调用函数的传入参数。因为_bstrt_t不能支持一些关键性操作，比如Detach。 ● 对于VC++ .Net推荐使用_bstr_t，它是C++扩展，不需要额外包含ATL的文件。
最低	BSTR	● COM接口

BSTR利弊

　　BSTR设计对于C++程序员好坏参半。

　　一方面，BSTR可以被用于大多数需要OLECHAR数组作为参数的函数。

　　另一方面，不能用熟悉的C/C++函数进行对BSTR的分配、释放和处理，例如malloc, free, new, delete, lstrcat, and lstrlen 等函数不能用于处理BSTR。就像对接口指针和类指针的处理不一样，对BSTR的处理和对TCHAR*的处理也不一样。BSTR是一种C语言方式的类型定义方式，这种定义方式提高了BSTR在C++的应用效率，但是也带来了很多的潜在风险，它使程序员失去了利用 编译器检查潜在问题的机会。

BSTR使用规则

　　●在对BSTR进行读取操作的时候，可以把BSTR看作OLECHAR数组。BSTR可以用于const wchar_t*(LPCTSTR/ LPCWSTR/ cosnt TCHAR*/ cosnt WCHAR* in Unicode project)，不能用于需要wchar_t* (LPTSTR/ LPWSTR/ TCHAR*/ WCHAR* in Unicode project)的地方。

　　● 如果有相应的BSTR处理函数，必须使用BSTR处理函数，不要使用普通字符串函数。特别是一个BSTR包含多个字符串(也就是，包含多个0结束符)的情况。在对BSTR进行修改（包括创建和释放时），必须使用BSTR的专用函数。主要要保证对字符长度前缀的正确修改。不要直接读取BSTR的长度域，应该使用BSTR处理函数计算长度。

　　

String Manipulation Functions	Descriptions
SysAllocString	Creates and initializes a string.
SysAllocStringByteLen	Creates a zero-terminated string of a specified length.
SysAllocStringLen	Creates a string of a specified length.
SysFreeString	Frees a previously created string.
SysReAllocString	Changes the size and value of a string.
SysReAllocStringLen	Changes the size of an existing string.
SysStringByteLen	Returns the length of a string in bytes.
SysStringLen	Returns the length of a string.

　　●NULL是BSTR的有效值。按照约定，它可以被看作含有0个字符的字符串。BSTR变量必须等于NULL，或者正确分配的BSTR指针。在改变BSTR变量的之前，必须释放原来指向的BSTR。不要把BSTR直接初始化成常量字符指针，例如，BSTR bs = L””。

　　●Automation会cache BSTR使用的空间，以提高SysAllocString/SysFreeString 的性能，会给测试发现问题带来困难。如果可能推荐在调试时使用Compuware DevPartner 7.x及更高版本的工具。

 

使用：

 

1         How to use BSTR

1.1      BSTR分析

BSTR 设计对于 C++ 程序员好坏参半。 一方面， BSTR 可以被用于大多数需要 OLECHAR 数组作为参数的函数。另一方面，不能用熟悉的 C/C++ 函数进行对 BSTR 的分配、释放和处理，例如 malloc, free, new, delete, lstrcat, and lstrlen 等函数不能用于处理 BSTR 。就像对接口指针和类指针的处理不一样，对 BSTR 的处理和对 TCHAR* 的处理也不一样。 BSTR 是一种 C 语言方式的类型定义方式，这种定义方式提高了 BSTR 在 C++ 的应用效率，但是也带来了很多的潜在风险，它使程序员失去了利用编译器检查潜在问题的机会。

1.2      BSTR使用基本规则

 

• 在对BSTR进行读取操作的时候，可以把BSTR看作OLECHAR数组。BSTR可以用于const wchar_t*(LPCTSTR/ LPCWSTR/ cosnt TCHAR*/ cosnt WCHAR* in Unicode project)，不能用于需要wchar_t* (LPTSTR/ LPWSTR/ TCHAR*/ WCHAR* in Unicode project)的地方。
• 如果有相应的BSTR处理函数，必须使用BSTR处理函数，不要使用普通字符串函数。特别是一个BSTR包含多个字符串(也就是，包含多个0结束符)的情况。在对BSTR进行修改（包括创建和释放时），必须使用BSTR的专用函数。主要要保证对字符长度前缀的正确修改。不要直接读取BSTR的长度域，应该使用BSTR处理函数计算长度。

 

String Manipulation Functions	Descriptions
SysAllocString	Creates and initializes a string.
SysAllocStringByteLen	Creates a zero-terminated string of a specified length.
SysAllocStringLen	Creates a string of a specified length.
SysFreeString	Frees a previously created string.
SysReAllocString	Changes the size and value of a string.
SysReAllocStringLen	Changes the size of an existing string.
SysStringByteLen	Returns the length of a string in bytes.
SysStringLen	Returns the length of a string.

 

• NULL是BSTR的有效值。 按照约定，它可以被看作含有0个字符的字符串。BSTR变量必须等于NULL，或者正确分配的BSTR指针。在改变BSTR变量的之前，必须释放原来指向的BSTR。不要把BSTR直接初始化成常量字符指针，例如，BSTR bs = L””。
• Automation会cache BSTR使用的空间，以提高SysAllocString/SysFreeString 的性能，会给测试发现问题带来困难。如果可能推荐在调试时使用Compuware DevPartner 7.x及更高版本的工具。

 

1.3      BSTR参数使用

多数时候， BSTR 是被用于函数参数。关于 BSTR 参数的使用规则是 BSTR 类型的基础。只有熟练掌握，才能分析 warpper 类或转换函数的正确性。

 

 基本原则：在给by-reference[in/out]参数赋一个新的值前，被调用者负责释放。其他情况，都是调用者负责释放。

 

调用者使用BSTR的规则如下：

·         释放被调用函数返回的 BSTR ，或者被调用函数通过 by-reference 返回的 BSTR 。

HRESULT IWebBrowser2::get_StatusText( BSTR FAR* pbstr );

//...

BSTR bstrStatus;

pBrowser->get_StatusText( &bstrStatus );

 

// shows using the Win32 function

// to freee the memory for the string:

::SysFreeString( bstrStatus );

 

·         释放通过 by-value 方式传给其他函数的 BSTR.

//.h

HRESULT IWebBrowser2::put_StatusText( BSTR bstr );

 

//.cpp

// shows using the Win32 function

// to allocate memory for the string:

BSTR bstrStatus = ::SysAllocString( L"Some text" );

if (bstrStatus == NULL)

   return E_OUTOFMEMORY;

 

pBrowser->put_StatusText( bstrStatus );

// Free the string:

::SysFreeString( bstrStatus );

//...

 

被调用者按照如下规则处理BSTR：

·         如果一个 BSTR 参数是 by-reference 方式，在给参数赋新值之前， Free 以前的值。如果没有给参数赋的新值，不要 Free 传入值。

void RefreshBSTR(BSTR& bs)

// bs is an [in/out] parameter. BSTR* is the same

{

// using the bs here

Dosomething(bs);

// if (bs is about to be updated)

ASSERT(bs != NULL);

::SysReallocString(bs, _T(“NEW STRING”));

// SysReallocString will call SysFreeString and

// SysAllocString in sequence

// If bs is only [out] parameter, SysAllocString

// should be called here.

}

 

·         不要 Free 通过 by-value 传入的 BSTR 。

void SetBSTR(BSTR bs)

// bs is an [in] parameter. BSTR* is the same

{

// using the bs here

Dosomething(bs);

::SysFreeString(bs); //ERROR

}

 

·         不要 Free 返回给调用者的 BSTR .

BSTR GetBSTR1()

{

BSTR bs = ::SysAllocString(_T(“test”));

::SysFreeString(bs); //ERROR

return bs;

}

 

void GetBSTR2(BSTR* pBs)

{

CComBSTR bs(_T(“test”));

*pBS = (BSTR) bs; //ERROR: pBS will be freed automatically

}

 

·         如果需要保存传入的 BSTR ，被调用着需要用 SysAllocString() 生成一个新的副本，并保存。输入的 BSTR 会被调用者释放。

void MyClass::SetBSTR(BSTR bs)

{

//BSTR m_bs;

m_bs = bs; //ERROR

m_bs = ::SysReAllocString(bs);

}

·         如果需要返回一个已经存储的 BSTR ，返回 BSTR 的一个拷贝。调用者释放返回的 BSTR 拷贝。

void MyClass::GetBSTR(BSTR* pbs)

{

//BSTR m_bs;

*pbs = m_bs; //ERROR

*pbs = ::SysAllocString(m_bs);

}