BSTR 字符串

天云上人

原文：http://www.vckbase.com/document/viewdoc/?id=1911
* P* d- O- ?( Y1 s8 R& w
BSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   % e" z# v) D) m9 [. w* b' W
2. typedef WCHAR OLECHAR;
     ^+ R2 ~6 L( X8 v" l. t2 F$ U6 U" k
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);
   3 R8 W9 y) V0 R
2. INT  SysReAllocString(BSTR* pbstr,const OLECHAR* psz);
   
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   9 u  b2 e; G* k+ @4 |
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   6 F5 L4 w; |1 P$ i  I
5. void SysFreeString(BSTR bstrString);
   + F) a2 l8 X  F" q" e) p5 [) B
6. UINT SysStringLen(BSTR);
   
7. UINT SysStringByteLen(BSTR bstr);
   
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，输入如下语句：

% e0 J; R1 Q3 F1 S2 R3 f5 n. pprintf("bstr front 4 byte is %x",*((int*)(((int*)bstr-1))));

9 O  O* S3 u% ?& w& w3 v1 {9 Z: i语句中的bstr是以上刚刚生成的BSTR组符串，此语句显示的结果是“bstr front 4 byte is 24”换算成10进制正好是34，是“create bstr string”长度的2倍因为BSTR字符串中的字符是用Unicode表示的，而语句

* t* M$ x, k2 a5 w5 ?2 _. dprintf("bstr front 0 byte is %c",*((int*)((int*)bstr)));
0 [$ y( s1 `: u  S1 Z
输出的是“c”是语句中的第一个字符，语句

2 I! N% O2 L% P8 }7 w) o: e9 Kprintf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。
9 [; E: A0 K; K0 `( R' A, m2 M* s- q
) h+ j" a( L1 T! @! |- ^! K; v, _3 x: ]2、SysReAllocString用于在一个已有的BSTR字符串的基础上重新建立一个BSTR字符串，输入如下的语句，可以检测该函数使用后的效果：

1. BSTR bstr=SysAllocString(L"create bstr string");   
   
2. SysReAllocString (&bstr,L"new string");printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));
   ' a. J- g& N. f  o. t  E
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   - L' z% G: O! h
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所指出的长度范围。但如果新的字符串如果超出原来串的长度，那么原来的字符串将被全部覆盖，长度以新的字符串为准，下面的语句说明了这一点。  
( _2 a( Y/ G, Z6 g! Q+ V1 R8 V

1. SysReAllocString (&bstr,L"new string new string");   
   + M: m3 f/ K) Q5 q  q* H  k6 U
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字符串，例如：
" g, e  o5 E6 e

1. BSTR bstr=SysAllocStringLen(L"create bstr string",6);   
   3 q* Z% `( P+ K3 ^
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   ; ]' o; \8 z, X
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串。
( \+ j3 Y" _& O4、SysReAllocStringLen函数是在已有的字符串的基础上按指定长度重新分配一个新的BSTR字符串。如：

1. BSTR bstr=SysAllocString(L"create bstr string");   
   ) S" |* _8 F6 L; A1 [: q; k4 g* W5 U  \
2. SysReAllocStringLen(&bstr,L"new string",3);
   
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)));
   % ^* T% I( ?+ n4 q3 P* Y
5. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

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

1. SysFreeString(bstr);

复制代码

6、SysStringLen求一个BSTR字符串的长度，如：

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

复制代码

7、SysStringByteLen求一个BSTR字符串的字节长度，如：

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

复制代码

8、SysAllocStringByteLen是按字节长度分配一个BSTR字符串。
0 Z) b% n1 J) d  W/ U以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
6 R6 V" {* A" M. s7 Q+ Z3 U  @3 y+ [; UCComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
1、构造一个CComBSTR对象
0 s8 u" h) g; [7 T4 }. R( L. s
  s2 S. Y  g4 Q2 r: K+ t

1. CComBSTR bstr1;
   
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   
3. 
   
4. CComBSTR bstr2(L"this is a BSTR string");
   
5. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK); 创建一个包含"this is a BSTR string"字符串的CComBSTR 对象
   
6. 
   
7. CComBSTR bstr3(5);
   
8. MessageBox(NULL,bstr3.m_str ,L"bstr test",MB_OK);创建一个初始长度为5，含NULL的CComBSTR对象。
   8 `. h; S$ U6 S$ G
9. 
   
10. CComBSTR bstr4(3,L"this is a BSTR string");
    5 P: R( W. P8 t
11. MessageBox(NULL,bstr4.m_str ,L"bstr test",MB_OK);创建一个长度为3的CComBSTR对象，后面的字符串舍去。

复制代码

我们也可以从一个已经存在的CComBSTR对象创建另一个CCOmBSTR对象，如：

1. CComBSTR bstr1(L"this is a BSTR string");
   " M7 t* V" C% r" T2 H6 }' j
2. CComBSTR bstr2(bstr1);
   3 ]+ K! q9 q* R6 m
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}};
   0 \! y" H% ?: Z/ ]6 P) r+ g
2. CComBSTR bstr1(GUID_Sample);
   
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

2、CComBSTR定义的常用操作如下
（1）“=”操作符（赋值操作），如：
# a1 E4 W2 U# U0 a0 B, h9 n7 j

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2=bstr1;
   8 f$ A8 o0 {& N
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");
   
2. BSTR bstr2=bstr1;
   " C4 }4 F+ M/ H
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   
4. 
   
5. CComBSTR bstr1(L"this is a BSTR string");
   7 x; T2 Y7 b# a' p( f% C# i7 Z
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：
) Q) ~. ^: w7 F1 t

1. CComBSTR bstr1(L"this is a BSTR string1");
   / q( d/ f& b0 {) w! _* t
2. CComBSTR bstr2(L"this is a BSTR string2");
   
3. if (bstr1!=bstr2){
   
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   
5. }
   
6. else
   
7. {
   ) V5 ]- ~0 w$ c( T: ^
8.         MessageBox(NULL,L"false",L"BSTR
   7 o- j: r( c$ }4 N* H; K
9. test",MB_OK);
   & f: }' D3 d* [. H
10. }

复制代码

3、CComBSTR定义的常用方法如下
. F3 V, Y  G# g& t* `（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：

1. CComBSTR bstr1(L"this is a BSTR string1");
   2 `6 g$ y' m+ |( @0 }
2. BSTR bstr2=bstr1.Copy ();
   + c9 B, G& \! T1 H
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（2）CopyTo 方法将CComBSTR对象中的BSTR字符串拷贝到新的位置，必须显式的调用SysStringFree来释放返回的字符串，如：
" H; Y) d8 H0 D2 L8 t1 K( J3 P5 U% x, A

1. CComBSTR bstr1(L"this is a BSTR string1");
   2 Y3 a9 r' S6 \" A3 V3 m
2. BSTR bstr2;
   0 U0 ]5 v, o2 p
3. bstr1.CopyTo(&bstr2);
   - |8 o6 m) [0 `' ^( a2 I* R  p
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

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

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   
2. CComBSTR bstr2;
   
3. bstr2.Attach(bstr1);
   ' k1 m9 D3 ]3 J3 Z7 |$ K8 {% T
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：
; ?& z. O9 z* |5 O" ]7 Z& y

1. bstr2.Detach ();

复制代码

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