BSTR 字符串

天云上人

原文：http://www.vckbase.com/document/viewdoc/?id=1911

* ]& G/ s2 x) s$ g" JBSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
' h& L7 e. W& c# l2 \( W# t对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：
0 q! Y: p8 G' l% h: S

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   : ^, p- F) q3 u  X  E
2. typedef WCHAR OLECHAR;
   
3. typedef wchar_t WCHAR;

复制代码

由于COM是跨系统及不同开发语言间实现互操作的技术，常规以Null结尾的简单字符串在COM 组件间传递不太方便。因此，便出现了BSTR字符串类型，BSTR是指针类型，标准BSTR是一个有长度前缀和null结束符的OLECHAR数组。BSTR的前4字节是一个表示字符串长度的前缀。BSTR长度域的值是字符串的字节数，但不包括字符串结束符。 BSTR实际上包含的是Unicode串，所以字符数是字节数的一半。这种方式的优点是允许程序员在BSTR串中间嵌入NULL字符，字符串的长度由BSTR的前四个字节表示，（长度中可能包含NULL），bstr字符串是不能象基本数据类型一样直接进行定义的。为处理BSTR字符串，微软在OleAuto.h中定义了BSTR API，分别是：

1. BSTR SysAllocString(const OLECHAR * psz);
   
2. INT  SysReAllocString(BSTR* pbstr,const OLECHAR* psz);
   
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   1 P( W5 p( d! X3 b
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   
5. void SysFreeString(BSTR bstrString);
   $ d& W0 X4 \1 c0 Q' M) p4 K$ I
6. UINT SysStringLen(BSTR);
   
7. UINT SysStringByteLen(BSTR bstr);
   1 ?- F2 a$ U$ L2 Y. m* @9 F6 Y( s% C" e
8. BSTR SysAllocStringByteLen(LPCSTR psz,UINT len);

复制代码

下面对上述API用法进行说明。

1、SysAllocString函数用于创建一个BSTR字符串，如：BSTR bstr=SysAllocString(L"create bstr string");就创建了一个BSTR字符串，上面说过BSTR字符串最初4个字节表示了字符串中字符个数，接下来是字符串中包含的真实字符，下面我们验证一下是否是这样的。我们生成一个WIN32控制台工程，生成时选择支持ATL的头文件，也可以后添加相应的头文件，主要是atlbase.h和atlstr.h，输入如下语句：

printf("bstr front 4 byte is %x",*((int*)(((int*)bstr-1))));

语句中的bstr是以上刚刚生成的BSTR组符串，此语句显示的结果是“bstr front 4 byte is 24”换算成10进制正好是34，是“create bstr string”长度的2倍因为BSTR字符串中的字符是用Unicode表示的，而语句

0 [1 g6 C0 @4 \printf("bstr front 0 byte is %c",*((int*)((int*)bstr)));

输出的是“c”是语句中的第一个字符，语句

7 L9 G2 \# c8 x, E5 r  l$ p: Xprintf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

, ^  L% d4 j, v输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。
  x: g' n+ [) y
2、SysReAllocString用于在一个已有的BSTR字符串的基础上重新建立一个BSTR字符串，输入如下的语句，可以检测该函数使用后的效果：

1. BSTR bstr=SysAllocString(L"create bstr string");   
   1 U% m- P0 U& D0 j6 F% [
2. SysReAllocString (&bstr,L"new string");printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));
   
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   
4. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

该语句最后输出是“14，n，g”说明SysReAllocString (&bstr,L"new string");语句是在已经生成的bstr字符串上建立一个新的字符串，因新串“new string”的长度是20，换算成16进制正好是14，而输出的g说明因新串短于旧串所以原字符串超出的部分为变化，但已经超出14所指出的长度范围。但如果新的字符串如果超出原来串的长度，那么原来的字符串将被全部覆盖，长度以新的字符串为准，下面的语句说明了这一点。  

1. SysReAllocString (&bstr,L"new string new string");   
   
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   
4. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

3、SysAllocStringLen按照指定的长度分配一个BSTR字符串，例如：

1. BSTR bstr=SysAllocStringLen(L"create bstr string",6);   
   
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   $ I- W% ?' I" c9 y, I) Y
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

虽然“create bstr string”的长度是18个字符但此语句只分派6个字符的BSTR串。
- D+ N+ J! ~% {7 L" \, o0 ^4、SysReAllocStringLen函数是在已有的字符串的基础上按指定长度重新分配一个新的BSTR字符串。如：

1. BSTR bstr=SysAllocString(L"create bstr string");   
   
2. SysReAllocStringLen(&bstr,L"new string",3);
   7 Y7 N# n! X: V+ c3 t1 _
3. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));
   
4. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   
5. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

5、SysFreeString是释放一个BSTR字符串，BSTR字符串用后必须用此函数进行释放，例如：
9 n' ~4 k. ]1 T0 f, G

1. SysFreeString(bstr);

复制代码

6、SysStringLen求一个BSTR字符串的长度，如：
( `* {3 \; B8 `6 p& g) F

1. printf("bstr size is %d\n",SysStringLen(bstr));其长度是指字符串中字符个数，而非字节数。

复制代码

7、SysStringByteLen求一个BSTR字符串的字节长度，如：
. `+ [  ]7 s" u+ i0 Q6 V

1. printf("bstr size is %d\n",SysStringByteLen(bstr));

复制代码

8、SysAllocStringByteLen是按字节长度分配一个BSTR字符串。
以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
  j- d0 s) t5 P) a0 f1 Y" OCComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
# T4 R6 ]" H1 f1 Z1、构造一个CComBSTR对象

* u8 u. ?* ~2 ]* ^# ~

1. CComBSTR bstr1;
   
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   9 z- |, ?: r0 m1 ]; {( W
3. 
   6 m9 t0 Z' F" ]5 |4 |: |4 v( M% n4 C
4. CComBSTR bstr2(L"this is a BSTR string");
   ) x2 S: n5 `3 t( U6 [
5. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK); 创建一个包含"this is a BSTR string"字符串的CComBSTR 对象
   
6. 
   7 k2 @  p, R! }- p4 r
7. CComBSTR bstr3(5);
   
8. MessageBox(NULL,bstr3.m_str ,L"bstr test",MB_OK);创建一个初始长度为5，含NULL的CComBSTR对象。
   ; O4 z) Z+ j1 o: R! P
9. 
   
10. CComBSTR bstr4(3,L"this is a BSTR string");
    % U+ N2 v" c' {( T# H# q& v
11. MessageBox(NULL,bstr4.m_str ,L"bstr test",MB_OK);创建一个长度为3的CComBSTR对象，后面的字符串舍去。

复制代码

我们也可以从一个已经存在的CComBSTR对象创建另一个CCOmBSTR对象，如：
9 ?* r  I) k: d% K/ W5 [

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2(bstr1);
   8 m0 O/ W8 n" a$ L/ B1 A$ f
3. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK);

复制代码

最后的一个构造函数比较奇怪，他接受一个GUID参数，生成一个包含GUID字符串的CComBSTR对象，如：

1. static const GUID GUID_Sample={0X8a44e110,0xf134,0x11d1,{0x96,0xb1,0xba,0xdb,0xba,0xdb,0xad,0xcc}};
   * d- E6 W4 l" ~2 E* e
2. CComBSTR bstr1(GUID_Sample);
   
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

2、CComBSTR定义的常用操作如下
（1）“=”操作符（赋值操作），如：
! V, J+ f! _4 ]8 w

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2=bstr1;
   
3. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);bstr2和bstr1包含相同内容。

复制代码

（2）BSTR操作符把CComBSTR对象显式的或隐式的转换成BSTR字符串，如:

1. CComBSTR bstr1(L"this is a BSTR string");
   ; U+ N8 u6 l7 A$ h8 C
2. BSTR bstr2=bstr1;
   
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   ) Z% y; h1 t2 g9 J' r# }* U+ l4 U
4. 
   % }' W8 B  T, j; a& z7 l7 j& Z! `
5. CComBSTR bstr1(L"this is a BSTR string");
   
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：
/ {, s" |  B' U5 _8 b

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. CComBSTR bstr2(L"this is a BSTR string2");
   
3. if (bstr1!=bstr2){
   0 Q" v0 b) G! f2 }$ l' N" [
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   % ^* I4 |  i1 A( \
5. }
   
6. else
   * I7 C! Y' X4 e* @+ Q3 m4 K: C4 _- i
7. {
   
8.         MessageBox(NULL,L"false",L"BSTR
   $ {1 y$ V! [" j
9. test",MB_OK);
   # `3 I+ @# W! r/ f: }. y
10. }

复制代码

3、CComBSTR定义的常用方法如下
（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：
4 C+ a5 G) u$ J5 l: z9 A

1. CComBSTR bstr1(L"this is a BSTR string1");
   5 y" z4 A8 |! L% r9 `5 P% {
2. BSTR bstr2=bstr1.Copy ();
   " O3 S$ [6 f' z7 N
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（2）CopyTo 方法将CComBSTR对象中的BSTR字符串拷贝到新的位置，必须显式的调用SysStringFree来释放返回的字符串，如：
) z# t0 R6 _6 L0 s5 m

1. CComBSTR bstr1(L"this is a BSTR string1");
   ! o* {2 a- U  ^. \
2. BSTR bstr2;
   
3. bstr1.CopyTo(&bstr2);
   1 f/ Z4 m! [% ^) I7 a
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（3）Attach方法把一个BSTR字符串附加到CComBSTR对象上，如：

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   . f& C. U$ b( P: q4 M2 w( l
2. CComBSTR bstr2;
   & `4 b* e& ]3 C9 T1 @
3. bstr2.Attach(bstr1);
   
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：

1. bstr2.Detach ();

复制代码

（5）Empty 方法，释放对象中的BSTR字符串。 CComBSTR对象还有一些其它的方法，如附加字符串、大小写转换、对象持久性等并不常用。总之BSTR字符串是COM技术的基石，CComBSTR是处理BSTR字符串的利器，深入理解BSTR字符串是研究COM技术必须经过的关口。

: u' [8 Y: a& ~