BSTR 字符串

天云上人

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

# _5 W( h! {9 F9 o  iBSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：
- h+ ~3 @2 A* V1 C7 D

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   % H3 C) R; o3 O+ C  B
2. typedef WCHAR OLECHAR;
   ! `; `' t* \! r2 W. w9 ~
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);
   4 ~, H  [/ u8 I7 z7 F( m7 U& k& F
2. INT  SysReAllocString(BSTR* pbstr,const OLECHAR* psz);
   % {$ @! ?8 [; B* E
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   ; Y1 j' q4 _- @% c
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   
5. void SysFreeString(BSTR bstrString);
   
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，输入如下语句：

( ?/ ~: j/ Q% v  n* `& bprintf("bstr front 4 byte is %x",*((int*)(((int*)bstr-1))));

: a% T/ Y9 l0 L( O, K语句中的bstr是以上刚刚生成的BSTR组符串，此语句显示的结果是“bstr front 4 byte is 24”换算成10进制正好是34，是“create bstr string”长度的2倍因为BSTR字符串中的字符是用Unicode表示的，而语句
$ k. Y! `6 H( o% f+ p& I; n' ^, L
8 h; F. a, ]* [5 n( v8 nprintf("bstr front 0 byte is %c",*((int*)((int*)bstr)));

输出的是“c”是语句中的第一个字符，语句
$ W8 x# B: }* _7 ~  o$ G
printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));
% L  h5 [; v9 ^$ v
输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。
2 D! p' h( v! P8 s* {
/ s3 I" }  M  \0 D) J; r- I! Z2、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))));
   
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所指出的长度范围。但如果新的字符串如果超出原来串的长度，那么原来的字符串将被全部覆盖，长度以新的字符串为准，下面的语句说明了这一点。  
6 x3 T& C0 F( V$ T

1. SysReAllocString (&bstr,L"new string new string");   
   ! \  V) r; v: t2 y2 ?/ t* m
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   ! r0 ^$ J. X1 L3 d: W+ f+ I
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   4 k6 N4 y" L! G" @+ T- x
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))));   
   
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串。
4、SysReAllocStringLen函数是在已有的字符串的基础上按指定长度重新分配一个新的BSTR字符串。如：

1. BSTR bstr=SysAllocString(L"create bstr string");   
   ) W" I  [0 e) x; k+ w
2. SysReAllocStringLen(&bstr,L"new string",3);
   ( n. C8 ?  f/ ^& F2 {) K) J0 R
3. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));
   8 G7 i/ `1 {% z
4. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   6 n% W# x: ~. i; ]/ W# K
5. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

5、SysFreeString是释放一个BSTR字符串，BSTR字符串用后必须用此函数进行释放，例如：
0 s1 ^( v, ]0 f

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字符串。
! N# j% k; |0 n6 ~以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
CComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
1、构造一个CComBSTR对象
: v6 f! V) a9 D8 [

1. CComBSTR bstr1;
   7 {: o/ h/ w. V4 f) |2 X1 X* W5 V! g+ e
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   6 n) G' K" |* Y3 R; c! ]' g
3. 
   0 w9 [6 c) g' h2 a' u3 b7 T9 Z
4. CComBSTR bstr2(L"this is a BSTR string");
   # s# L" h6 ^) b0 l
5. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK); 创建一个包含"this is a BSTR string"字符串的CComBSTR 对象
   : G. r- Z3 T' w' }5 a
6. 
   - ], G; m  D9 e6 z0 @
7. CComBSTR bstr3(5);
   
8. MessageBox(NULL,bstr3.m_str ,L"bstr test",MB_OK);创建一个初始长度为5，含NULL的CComBSTR对象。
   - h9 `5 l  X$ i% A1 u5 L2 V
9. 
   
10. CComBSTR bstr4(3,L"this is a BSTR string");
    ' E8 k3 |7 |9 ~- K
11. MessageBox(NULL,bstr4.m_str ,L"bstr test",MB_OK);创建一个长度为3的CComBSTR对象，后面的字符串舍去。

复制代码

我们也可以从一个已经存在的CComBSTR对象创建另一个CCOmBSTR对象，如：
( u! p& h9 ]" [% u" ^. k( A) y

1. CComBSTR bstr1(L"this is a BSTR string");
   % M( p5 P& K& b9 u0 d
2. CComBSTR bstr2(bstr1);
   
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}};
   
2. CComBSTR bstr1(GUID_Sample);
   
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

2、CComBSTR定义的常用操作如下
（1）“=”操作符（赋值操作），如：

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2=bstr1;
   , O1 u8 \. a; c: z, ~# }
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");
   1 _. F+ p# k2 i. \9 y
2. BSTR bstr2=bstr1;
   
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   
4. 
   
5. CComBSTR bstr1(L"this is a BSTR string");
   : d. S0 V2 d9 e
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：
( s0 P- Q, A( L3 |( ]

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. CComBSTR bstr2(L"this is a BSTR string2");
   
3. if (bstr1!=bstr2){
   
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   $ b! F2 E9 J- b% L/ O( H. E# s
5. }
   9 }: ?' {3 i% x$ N" e7 s" G
6. else
   $ m/ U/ b4 P" b& V  q) n9 N
7. {
   
8.         MessageBox(NULL,L"false",L"BSTR
   ( r9 {  ~  p8 X5 B! e2 Y% z
9. test",MB_OK);
   
10. }

复制代码

3、CComBSTR定义的常用方法如下
  \4 K$ Y1 P* N1 M, C$ y, M+ z（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：
" {2 Q  ~3 ~. `3 @( r( \

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. BSTR bstr2=bstr1.Copy ();
   & r5 \3 O2 T7 Z% A" [" J+ `$ {
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（2）CopyTo 方法将CComBSTR对象中的BSTR字符串拷贝到新的位置，必须显式的调用SysStringFree来释放返回的字符串，如：
8 j: T8 h4 c* p

1. CComBSTR bstr1(L"this is a BSTR string1");
   ) M8 s# }# x9 z$ j# |% ]
2. BSTR bstr2;
   
3. bstr1.CopyTo(&bstr2);
   
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);
   4 r6 X$ I; I7 j& \% x3 n: t
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技术必须经过的关口。
7 A! h4 L! ?5 S! X4 a. ]7 T
9 h8 s9 G, \" E5 u4 u