BSTR 字符串

天云上人

原文：http://www.vckbase.com/document/viewdoc/?id=1911
5 L" t1 Z- T: e
- u% I# v. m2 I2 o  |  J* |BSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
) K: {8 I6 ~; `4 h对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：
$ u2 Y9 Q! W  P8 K" R5 P3 l1 R

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   + t. O, N/ J$ J/ E2 u7 J
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);
   / p: H7 Q7 ]! I. z( N
2. INT  SysReAllocString(BSTR* pbstr,const OLECHAR* psz);
   
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   8 t  |* Y3 P& x5 Z# d
5. void SysFreeString(BSTR bstrString);
   " f8 c4 d, Z5 S1 b3 J4 k' b+ Q
6. UINT SysStringLen(BSTR);
   
7. UINT SysStringByteLen(BSTR bstr);
   ! A- O( G/ x0 a. A1 ?& M: Q$ u- K
8. BSTR SysAllocStringByteLen(LPCSTR psz,UINT len);

复制代码

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

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

% o0 ^' Q7 o+ \3 F6 Sprintf("bstr front 4 byte is %x",*((int*)(((int*)bstr-1))));
3 m( N# E5 `2 S; J+ _( E9 u8 o% E( c
4 c1 [3 e" e8 n; K( @8 t语句中的bstr是以上刚刚生成的BSTR组符串，此语句显示的结果是“bstr front 4 byte is 24”换算成10进制正好是34，是“create bstr string”长度的2倍因为BSTR字符串中的字符是用Unicode表示的，而语句
" Q, ~% h. t" n3 \  {) @. @
) v3 f, K' h% N( N' Gprintf("bstr front 0 byte is %c",*((int*)((int*)bstr)));

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

- j8 O  J/ w. H# B9 ?2 a) u( k; bprintf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));
. S; d$ H+ d, m0 M9 a' x1 S2 R0 m
$ m  C9 U0 C: F  C8 _& z9 c输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。
. e; E0 B! s- l
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))));
   
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 u5 @3 }3 }/ H  y& l- Q

1. SysReAllocString (&bstr,L"new string new string");   
   
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   ' Y8 m7 q  c& R8 F9 a' [  o
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   : q- s1 Z# D8 f8 U, C
4. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

3、SysAllocStringLen按照指定的长度分配一个BSTR字符串，例如：
; \& R/ c$ `, Q7 ~; x2 Q( P

1. BSTR bstr=SysAllocStringLen(L"create bstr string",6);   
   2 U- s7 R+ t# Z( A* s6 J
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   ! v2 x& e" t6 ~# c3 z
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");   
   
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)));
   
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字符串。
以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
$ ^' Z3 ^& ~" i/ DCComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
% l5 R5 V4 R1 p" C1 J1、构造一个CComBSTR对象
# F/ [, \, a8 k+ Z% j

1. CComBSTR bstr1;
   % j+ h. [- R# K% @3 N; r
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   
3. 
   ( d: U5 F' m$ Y' F6 V2 {: Y( Y& m) D, y
4. CComBSTR bstr2(L"this is a BSTR string");
   / t. d2 ~: H9 S6 o" z( {
5. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK); 创建一个包含"this is a BSTR string"字符串的CComBSTR 对象
   * @# A! ], X* c2 j
6. 
   
7. CComBSTR bstr3(5);
   2 m% e8 `# j' h1 X& m7 J
8. MessageBox(NULL,bstr3.m_str ,L"bstr test",MB_OK);创建一个初始长度为5，含NULL的CComBSTR对象。
   / N# G& D/ x' n( \- c
9. 
   ; Z3 O& @0 i' s* r+ ]) Z
10. CComBSTR bstr4(3,L"this is a BSTR string");
    4 v- E, n# @0 }0 L
11. MessageBox(NULL,bstr4.m_str ,L"bstr test",MB_OK);创建一个长度为3的CComBSTR对象，后面的字符串舍去。

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string");
   - l0 w7 q  S* D# l
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}};
   , _6 Q! W) D9 u2 h4 l- G
2. CComBSTR bstr1(GUID_Sample);
   
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

2、CComBSTR定义的常用操作如下
  O' z, v  `# I" E) [（1）“=”操作符（赋值操作），如：

1. CComBSTR bstr1(L"this is a BSTR string");
   / [; [# j0 j( z2 @- w
2. CComBSTR bstr2=bstr1;
   ; b% U: A: ]( q& ~
3. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);bstr2和bstr1包含相同内容。

复制代码

（2）BSTR操作符把CComBSTR对象显式的或隐式的转换成BSTR字符串，如:
" S4 k8 C" Z- f; r2 Y! b  M- p

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. BSTR bstr2=bstr1;
     P$ D2 r# W8 @
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   % z, R( ~( P/ G
4. 
   " A' L- a+ I/ ^: L( @9 S! z8 M
5. CComBSTR bstr1(L"this is a BSTR string");
   9 s) G6 I3 u, v! S
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string1");
   & j5 g8 v! W, C7 o* x- Z4 c& L
2. CComBSTR bstr2(L"this is a BSTR string2");
   ' A+ Z! f6 e  m5 k! k
3. if (bstr1!=bstr2){
   * e6 A* z$ a% t6 D- a% X
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   + Y$ R$ w7 r3 q& H! x% n* W0 x9 c% ~
5. }
   
6. else
   5 i4 {! V$ R/ `
7. {
   
8.         MessageBox(NULL,L"false",L"BSTR
   
9. test",MB_OK);
   
10. }

复制代码

3、CComBSTR定义的常用方法如下
  y3 O/ Z  T  o( m( X（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：

1. CComBSTR bstr1(L"this is a BSTR string1");
   " [" x! K$ D) ]. z. I
2. BSTR bstr2=bstr1.Copy ();
   3 C% b& N4 W" k
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. BSTR bstr2;
   
3. bstr1.CopyTo(&bstr2);
   6 o- q& t  y$ J
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

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

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   3 X% G5 |$ u. L/ x) s
2. CComBSTR bstr2;
   8 ], ^, X7 R6 L0 L/ V8 M- _( a
3. bstr2.Attach(bstr1);
   7 {$ D7 ?/ Q9 h% }' K: e" B7 d
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：
4 |+ R2 ]% `. V, i

1. bstr2.Detach ();

复制代码

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