BSTR详解

大家好，欢迎来到IT知识分享网。

BSTR详解一 – BSTR简介和内部结构

• C++ 字符串是以0结束的ASCII或Unicode字符数组
• Visual Basic字符串是一个ASCII字符数组加上表示长度的前缀。
• Java字符串是以0结束的Unicode字符数组。

• 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看作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及更高版本的工具。

CComBSTR Method	Description
CComBSTR	多个版本的构造函数用来创建新的BSTR。可以使用的参数包括LPCOLESTR, LPCSTR, CComBSTR。
~CComBSTR, Empty	释放内部封装的BSTR.
Attach, Detach, Copy	Attach 把一个已经存在 BSTR 加入类中。 Detach 把劣种的 BSTR 剥离，以便在超出作用域的时候，析构函数不会释放 BSTR 。 Detach 用于把 CComBSTR  赋给 [out] 参数。 Copy 用于产生一个 BSTR 的副本。一般用于用于把 CComBSTR 内容赋给 [out] 参数。
operator BSTR, operator&	允许直接操作内部的BSTR。operator BSTR用于把CComBSTR传给BSTR输入[in]参数。operator&用于把CComBSTR传给BSTR*类型输出[out]参数。
operator=, operator+=, operator<, operator==, operator>	重载运算符，用于赋值、字符串连接、简单比较。
Append, AppendBSTR	字符串连接
Length	计算字符串长度
LoadString	利用字符串资源初始化BSTR。
ToLower, ToUpper	字符串大小写转换。
WriteToStream,ReadFromStream	从IStream中读/写BSTR。

Features Not Included in CComBSTR	Explanation
LPCSTR extraction	CComBSTR 可以把一个单字节字符串转换成BSTR，但是没有提供反向转换的功能。_bstr_t 提供了LPCTSTR operator。
String manipulation (including Replace, Insert, Delete, Remove, Find, Mid, Left, Right, and so on)	CComBSTR没有提供这些方法。如果需要，可以使用STL中的wstring。
Language-sensitive collation	CComBSTR 提供的字符串比较(<, >, ==)按照是byte-by-byte方式进行的。没有提供语言相关的比较(language-specific collation)。如果需要可以使用wstring.

Construction	Version
_bstr_t		Constructs a _bstr_t object.
Operations
Assign		Copies a BSTR into the BSTR wrapped by a _bstr_t.
Attach	VC 7	Links a _bstr_t wrapper to a BSTR.
copy		Constructs a copy of the encapsulated BSTR.
Detach	VC 7	Returns the BSTR wrapped by a _bstr_t and detaches the BSTR from the _bstr_t.
GetAddress	VC 7	Points to the BSTR wrapped by a _bstr_t.
GetBSTR	VC 7	Points to the beginning of the BSTR wrapped by the _bstr_t.
length		Returns the number of characters in the _bstr_t.
Operators
operator =		Assigns a new value to an existing _bstr_t object.
operator +=		Appends characters to the end of the _bstr_t object.
operator +		Concatenates two strings.
operator !		Checks if the encapsulated BSTR is a NULL string.
operator ==, !=, <, >, <=, >=		Compares two _bstr_t objects.
operator wchar_t* | char*		Extract the pointers to the encapsulated Unicode or multibyte BSTR object.

From	To	Sample
字符串常量	BSTR	Right: BSTR bs = ::SysAllocString(_T(“Test string”)); … ::SysFreeString(); Wrong: BSTR bs = _T(“Test string”); //ERROR
LPWSTR / LPCWSTR / WCHAR* / wchar_t	BSTR	Right: LPCTSTR sz1 = _T(“Test String”); BSTR bs = ::SysAllocString(sz1); … ::SysFreeString();   Wrong: LPTSTR sz1 = _T(“Test String”); BSTR bs = sz1; //ERROR
BSTR	LPCWSTR / const WCHAR * / const wchar_t *	Right: BSTR bs = …; // … LPCTSTR sz = static_cast<LPCTSTR>bs; … ::SysFreeString(bs); //Never use sz after this line   Wrong: BSTR bs = …; // …   LPCTSTR sz = bs; … ::SysFreeString(bs); //Never use sz after this line _tcslen(sz); //ERROR
BSTR	LPWSTR / WCHAR* / wchar_t*	Right: BSTR bs = …; // //… UINT len = ::SysStringLen(bs);   // Do not modify the BSTR content by // C/C++ string functions LPTSTR sz = new TCHAR[len+1]; _tcsncpy(sz, bs, len); ::SysFreeString(bs);   delete []sz; Wrong: BSTR bs = …; // //…   // Do not modify the BSTR content by // C/C++ string functions LPTSTR sz = bs; //Error
CString	BSTR	Right:   CString str1 = …;   BSTR bs = str1.AllocSysString(); SomeMethod(bs); // void SomeMethod([in]BSTR) ::SysFreeString(bs);   CComBSTR bs1(static_cast<LPCTSTR>(str1)); SomeMethod(static_cast<BSTR> (bs1) );   // void SomeMethod([in] BSTR ) _bstr_t bs2( static_cast<LPCTSTR>(str1)); SomeMethod(static_cast<BSTR> (bs2) );   Wrong: CString str1 = …;   SomeMethod(str1.AllocSysString());   // No one will releasee the return BSTR of // str1.AllocSysString()
BSTR	CString	Right:   BSTR bs = SysAllocString(_T(“Test”)); CString str1(bs); CString str2; Str2 = bs; SysFreeString(bs); // Never forget this line
char* / LPSTR / LPCSTR	BSTR	Right: Solution 1： char str[MAX_STR_LEN] = “ANSI string”; WCHAR wstr[MAX_WSTR_LEN]; // Convert ANSI to Unicode   MultiByteToWideChar( CP_ACP, 0, str,         strlen(str)+1, wstr,        sizeof(wstr)/sizeof(wstr[0]) );   BSTR bs1 = ::SysAllocString(wstr);   CString cs = str; BSTR bs2 = cs. AllocSysString()   Solution 2： char str[MAX_STR_LEN] = “ANSI string”; _bstr_t bs1(str); CComBSTR bs2(str);   Wrong: char *str = “ANSI string”; BSTR bstr1 = SysAllocString(             (const OLECHAR*) str);
BSTR	char* / LPSTR / LPCSTR	Right: Solution 1： char str[MAX_STR_LEN]; BSTR bs = ::SysAllocString(L”Test”); // Convert ANSI to Unicode WideCharToMultiByte( CP_ACP, 0,    (LPCWSTR)bs, -1,    str, MAX_STR_LEN, NULL, NULL ); ::SysFreeString(bs);   Solution 2： BSTR bs = ::SysAllocString(L”Test”); _bstr_t bs1(bs, false); const char* str = static_cast <const char*> bs1;   Wrong: BSTR bstr1 = SysAllocString(L”ANSI string”); char *str = (char*) bstr1;