BSTR 字符串

天云上人

原文：http://www.vckbase.com/document/viewdoc/?id=1911
9 M& Y3 q3 d" Z) t
& A4 q5 Q, ]2 J2 O" o7 y: W" JBSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：
$ V& I2 \6 Q  n, \  y

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   5 T! a: o0 \4 K
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);
   ( S/ P" O6 _* I; s+ t
2. INT  SysReAllocString(BSTR* pbstr,const OLECHAR* psz);
   ' k2 C+ D7 a: z, H" w
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   0 v6 J1 ]' y4 p
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   # K% @. K( X2 v3 d7 S/ Q
5. void SysFreeString(BSTR bstrString);
   
6. UINT SysStringLen(BSTR);
   
7. UINT SysStringByteLen(BSTR bstr);
   - O1 \' K! y; B0 s; w- p
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，输入如下语句：

) r- i) g$ s# s, fprintf("bstr front 4 byte is %x",*((int*)(((int*)bstr-1))));
% J; ~7 l" E+ O: V
语句中的bstr是以上刚刚生成的BSTR组符串，此语句显示的结果是“bstr front 4 byte is 24”换算成10进制正好是34，是“create bstr string”长度的2倍因为BSTR字符串中的字符是用Unicode表示的，而语句
  \* @/ j' Z3 H6 _) u# k* s
5 {0 [. Z8 q! g$ s# Uprintf("bstr front 0 byte is %c",*((int*)((int*)bstr)));
2 C) g! x3 Q* f2 ^  E* D8 x" z
输出的是“c”是语句中的第一个字符，语句
& C* [. w. ]1 P) T2 C1 W4 R
printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));
2 A/ a9 A8 n$ U$ U7 u7 L: J$ |
1 J4 T# k+ }9 I' B& X输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。

2、SysReAllocString用于在一个已有的BSTR字符串的基础上重新建立一个BSTR字符串，输入如下的语句，可以检测该函数使用后的效果：

1. BSTR bstr=SysAllocString(L"create bstr string");   
   & t, L5 {* r$ {
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)));
   - p6 [, Z& ]% Q9 X; H! Y
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 j# p2 k( I# ~& p- j0 X3 x

1. SysReAllocString (&bstr,L"new string new string");   
     u* A6 [9 C0 s- x
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))));   
   $ `% w, b5 M1 R" f
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串。
; o5 O' M' G8 B% e4、SysReAllocStringLen函数是在已有的字符串的基础上按指定长度重新分配一个新的BSTR字符串。如：

1. BSTR bstr=SysAllocString(L"create bstr string");   
   
2. SysReAllocStringLen(&bstr,L"new string",3);
   3 t! ]( `5 b, l
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)));
   / i0 M* Y0 P; w" C( ^  F5 A4 @
5. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

5、SysFreeString是释放一个BSTR字符串，BSTR字符串用后必须用此函数进行释放，例如：

1. SysFreeString(bstr);

复制代码

6、SysStringLen求一个BSTR字符串的长度，如：
  U$ _0 C3 w7 j: T. M. h+ ?8 e) L

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

复制代码

7、SysStringByteLen求一个BSTR字符串的字节长度，如：
) @, K& I$ n. B( I' B5 B% p

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

复制代码

8、SysAllocStringByteLen是按字节长度分配一个BSTR字符串。
以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
- |7 H+ G% L7 {2 p7 }! C- a5 C' VCComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
1、构造一个CComBSTR对象

, q/ H$ q9 k  \7 h: z& z. M

1. CComBSTR bstr1;
   * R% `* y" e6 L- J
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   
3. 
   + T7 J1 c! Y* z7 |
4. CComBSTR bstr2(L"this is a BSTR string");
   ; I: q4 N" m7 |5 ]% }1 N* P
5. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK); 创建一个包含"this is a BSTR string"字符串的CComBSTR 对象
   $ n: \+ I  G" L4 k; D8 \! M/ Y
6. 
   
7. CComBSTR bstr3(5);
   
8. MessageBox(NULL,bstr3.m_str ,L"bstr test",MB_OK);创建一个初始长度为5，含NULL的CComBSTR对象。
   3 C0 G3 B% |7 ~9 F+ p; I5 `( e
9. 
   
10. CComBSTR bstr4(3,L"this is a BSTR string");
    
11. MessageBox(NULL,bstr4.m_str ,L"bstr test",MB_OK);创建一个长度为3的CComBSTR对象，后面的字符串舍去。

复制代码

我们也可以从一个已经存在的CComBSTR对象创建另一个CCOmBSTR对象，如：
( t' m0 c( _6 M  @  ]0 D

1. CComBSTR bstr1(L"this is a BSTR string");
   + \7 c" X4 T0 q# \$ ^
2. CComBSTR bstr2(bstr1);
   0 X1 v& }5 [4 t; t( D) ^
3. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK);

复制代码

最后的一个构造函数比较奇怪，他接受一个GUID参数，生成一个包含GUID字符串的CComBSTR对象，如：
/ N* b3 |0 r1 d8 a9 |# z7 J

1. static const GUID GUID_Sample={0X8a44e110,0xf134,0x11d1,{0x96,0xb1,0xba,0xdb,0xba,0xdb,0xad,0xcc}};
   
2. CComBSTR bstr1(GUID_Sample);
   * @( m- @7 e! H" O3 L
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

2、CComBSTR定义的常用操作如下
0 J( m4 Y" }- }（1）“=”操作符（赋值操作），如：

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2=bstr1;
   " S5 ?0 X3 d, Q; G6 \  N8 g
3. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);bstr2和bstr1包含相同内容。

复制代码

（2）BSTR操作符把CComBSTR对象显式的或隐式的转换成BSTR字符串，如:
* I6 p: {# w7 E: k& c& A

1. CComBSTR bstr1(L"this is a BSTR string");
   3 k! C  t4 O+ l; `/ [
2. BSTR bstr2=bstr1;
   & y; ]: r. k+ A8 L
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   
4. 
   . {4 `5 X7 Y$ a* G" w
5. CComBSTR bstr1(L"this is a BSTR string");
   
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：

1. CComBSTR bstr1(L"this is a BSTR string1");
   9 m$ g7 t- y" c$ b( s7 O# ^9 c& [! Y
2. CComBSTR bstr2(L"this is a BSTR string2");
   
3. if (bstr1!=bstr2){
   ' G  Q1 }; {3 z2 |( _5 d3 F
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   0 X- K3 l7 M; |* X2 S$ O, z
5. }
   
6. else
   
7. {
   
8.         MessageBox(NULL,L"false",L"BSTR
   
9. test",MB_OK);
   # D/ k  V. E: j# H- Z* L
10. }

复制代码

3、CComBSTR定义的常用方法如下
9 P6 j+ a- d5 |# u' {（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. BSTR bstr2=bstr1.Copy ();
   
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（2）CopyTo 方法将CComBSTR对象中的BSTR字符串拷贝到新的位置，必须显式的调用SysStringFree来释放返回的字符串，如：
/ M- e  D8 s$ E8 W2 b% l. A/ C

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. BSTR bstr2;
   
3. bstr1.CopyTo(&bstr2);
   + U" E: G' u& {9 h) F. L
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（3）Attach方法把一个BSTR字符串附加到CComBSTR对象上，如：
- d9 n5 z9 t8 Z. Y! ^; B3 j

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   
2. CComBSTR bstr2;
   
3. bstr2.Attach(bstr1);
   $ M! Y, P( }/ d) v
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：
: h- s2 o, M9 ~& x) W8 P

1. bstr2.Detach ();

复制代码

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