BSTR 字符串

天云上人

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

$ V) m, `( A' p/ n! B8 m) ?BSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
; E' c: Z2 S: p3 ]对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   
2. typedef WCHAR OLECHAR;
   $ O4 h2 [0 b1 l  ]7 U% ^% ~
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. y/ F# A1 e: R
2. INT  SysReAllocString(BSTR* pbstr,const OLECHAR* psz);
   - V6 M$ [/ g8 H
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   9 e' n/ i8 C7 x
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   
5. void SysFreeString(BSTR bstrString);
   
6. UINT SysStringLen(BSTR);
   & A% [' f2 f1 y4 Y
7. UINT SysStringByteLen(BSTR bstr);
   
8. BSTR SysAllocStringByteLen(LPCSTR psz,UINT len);

复制代码

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

: B: m* ^5 X8 [) X" G1、SysAllocString函数用于创建一个BSTR字符串，如：BSTR bstr=SysAllocString(L"create bstr string");就创建了一个BSTR字符串，上面说过BSTR字符串最初4个字节表示了字符串中字符个数，接下来是字符串中包含的真实字符，下面我们验证一下是否是这样的。我们生成一个WIN32控制台工程，生成时选择支持ATL的头文件，也可以后添加相应的头文件，主要是atlbase.h和atlstr.h，输入如下语句：
8 \4 D3 e5 h8 w- Z
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表示的，而语句
* O* S; B) \* n6 u& v: h
) `) P6 Z1 u- b6 Eprintf("bstr front 0 byte is %c",*((int*)((int*)bstr)));

' J& @  J% U3 t& }& k输出的是“c”是语句中的第一个字符，语句
) K% Y% o4 C' A, I
printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));
9 k7 |8 O( `, l! m# w; p
% C5 L$ D/ ?2 [* H& A$ A1 C0 B) G: x: ]输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。

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))));
   : ]1 N5 I  I: ~  n3 D  N0 A9 t0 R2 G
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");   
   8 w2 P; `* O" l, `* v
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   9 p, Z9 [) w9 b' F5 y. T( N4 W- x% |
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   5 |3 y3 E! @) S1 a  P
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);   
   ! @) P* u% @0 [8 Y& x
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   - A9 V0 K3 y6 w* 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串。
0 g5 S8 `; g) w+ c3 [  @7 V4、SysReAllocStringLen函数是在已有的字符串的基础上按指定长度重新分配一个新的BSTR字符串。如：
+ H! @0 }  }4 q) b" U# ~" L

1. BSTR bstr=SysAllocString(L"create bstr string");   
   / U/ @5 ]! y6 i% q1 ?# Y
2. SysReAllocStringLen(&bstr,L"new string",3);
   . Z& U  k2 \- v4 A6 H+ m' z* W( O
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字符串用后必须用此函数进行释放，例如：
, A' r/ i8 T7 a) Y! A# n! N) j: w2 ~* H+ z

1. SysFreeString(bstr);

复制代码

6、SysStringLen求一个BSTR字符串的长度，如：
$ i! ]) y& k# F6 m

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

复制代码

7、SysStringByteLen求一个BSTR字符串的字节长度，如：
) @) }2 s) _4 m2 x/ x' y$ @# R3 p( t5 z

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

复制代码

8、SysAllocStringByteLen是按字节长度分配一个BSTR字符串。
以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
" Q/ k& C9 f6 OCComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
( r! `7 a  |  b: ]) x0 h9 Y& ^8 d' }1、构造一个CComBSTR对象
  U  |6 H7 J: c1 D4 z. y' e

1. CComBSTR bstr1;
   
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   : t2 B  q4 h; H4 @0 S' q4 s
3. 
   7 c3 x" D7 ~( e  c$ ^8 k
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 对象
   - `! C- E) W7 j0 }$ L
6. 
   . |- ]0 \5 K& B
7. CComBSTR bstr3(5);
   
8. MessageBox(NULL,bstr3.m_str ,L"bstr test",MB_OK);创建一个初始长度为5，含NULL的CComBSTR对象。
   * k- A; O4 |5 t/ z2 m4 y
9. 
   3 w# A3 V4 n: L% V! H& C" S
10. CComBSTR bstr4(3,L"this is a BSTR string");
    1 r( w) s7 T# L+ K' N2 u
11. MessageBox(NULL,bstr4.m_str ,L"bstr test",MB_OK);创建一个长度为3的CComBSTR对象，后面的字符串舍去。

复制代码

我们也可以从一个已经存在的CComBSTR对象创建另一个CCOmBSTR对象，如：
, V7 ^0 K& [5 b4 u' ~6 T- b9 z

1. CComBSTR bstr1(L"this is a BSTR string");
   9 u2 Y# \- k8 s+ D4 H
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定义的常用操作如下
- I" I1 I' M+ z$ K8 n（1）“=”操作符（赋值操作），如：
' p, i- ^* O% E9 z" t5 R9 z

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字符串，如:
* {$ W0 O( R) L

1. CComBSTR bstr1(L"this is a BSTR string");
   8 z3 b9 m5 f& V. ^* r, Z
2. BSTR bstr2=bstr1;
   
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   
4. 
   
5. CComBSTR bstr1(L"this is a BSTR string");
   
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：
  G" z6 @% J- A5 b( b

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. CComBSTR bstr2(L"this is a BSTR string2");
   8 s/ }/ Q5 q  z8 k" h7 Y
3. if (bstr1!=bstr2){
   
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   
5. }
   4 v5 S% X+ T* F+ ]! f) M8 O/ m
6. else
   ) V7 f4 X/ ~- Z! b: w' y9 Y/ m
7. {
   6 v% b- N% M5 k) K* {- K' f
8.         MessageBox(NULL,L"false",L"BSTR
   
9. test",MB_OK);
     y3 @" S7 k- Z, b% U
10. }

复制代码

3、CComBSTR定义的常用方法如下
（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：
( J$ T% N& u5 b; J/ t, W

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来释放返回的字符串，如：
' d, M( k2 t0 a5 C! e* u" v6 A3 Z

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

复制代码

（3）Attach方法把一个BSTR字符串附加到CComBSTR对象上，如：
, D' y) s3 h; \; e3 p

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   
2. CComBSTR bstr2;
   # u' ]; R* [) `* S3 N0 x" B
3. bstr2.Attach(bstr1);
   0 v' q% l% F+ `9 m$ ^
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：
0 i9 G: z3 J; j" m$ @! ]0 z

1. bstr2.Detach ();

复制代码

（5）Empty 方法，释放对象中的BSTR字符串。 CComBSTR对象还有一些其它的方法，如附加字符串、大小写转换、对象持久性等并不常用。总之BSTR字符串是COM技术的基石，CComBSTR是处理BSTR字符串的利器，深入理解BSTR字符串是研究COM技术必须经过的关口。
. x. H6 `1 Z! }1 v7 A% A
" y9 G: Y; E5 z  ?/ q$ T