BSTR 字符串

天云上人

原文：http://www.vckbase.com/document/viewdoc/?id=1911
0 v) ~4 n* ~, U) |3 ?! h' N
+ j# n3 R8 \! q* D$ X: eBSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
' |' D! [$ G$ b; X; h. W# k对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：
+ P! A2 r( `4 C% t( X# W# x% _

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   0 T, w6 B- K5 e
2. typedef WCHAR OLECHAR;
     A* i! ~4 ]6 f) y
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);
   
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);
   
5. void SysFreeString(BSTR bstrString);
   ; M. ^1 t4 h) \, k+ j3 }5 x
6. UINT SysStringLen(BSTR);
   
7. UINT SysStringByteLen(BSTR bstr);
   0 R) L& B; a. s' d6 S
8. BSTR SysAllocStringByteLen(LPCSTR psz,UINT len);

复制代码

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

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

8 ?. @9 y8 Y$ \! d# W7 O+ Lprintf("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表示的，而语句

4 k/ @* g% T- M( {* X% @- U  _printf("bstr front 0 byte is %c",*((int*)((int*)bstr)));
; t' L3 w7 [6 E5 R5 C8 v. r, Q
输出的是“c”是语句中的第一个字符，语句
4 I) m2 p$ V3 F% ~; j
. j+ ~! G% D: G% q8 s0 a  j8 sprintf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));
( A( p4 U& Q/ ^4 \6 H: 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))));
   
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   4 g" ^* ^% y. U2 @
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所指出的长度范围。但如果新的字符串如果超出原来串的长度，那么原来的字符串将被全部覆盖，长度以新的字符串为准，下面的语句说明了这一点。  
$ D% _/ Z* s% w" a  u0 N# O4 T

1. SysReAllocString (&bstr,L"new string new string");   
   
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   9 H7 K* Q! _, [- Y2 O6 ]
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字符串，例如：
- R% [3 S/ t7 _: ]: A1 ]$ l+ s

1. BSTR bstr=SysAllocStringLen(L"create bstr string",6);   
   ; t  Y4 S  L* k
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   3 H4 S/ r1 ?, A! q$ r0 k
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串。
% B: G9 I" x2 k  }4、SysReAllocStringLen函数是在已有的字符串的基础上按指定长度重新分配一个新的BSTR字符串。如：
4 h9 i6 F: z5 x* L* m

1. BSTR bstr=SysAllocString(L"create bstr string");   
   9 }# t5 k+ X  n4 D' k
2. SysReAllocStringLen(&bstr,L"new string",3);
   $ T& P! y$ }( 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)));
   
5. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

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

1. SysFreeString(bstr);

复制代码

6、SysStringLen求一个BSTR字符串的长度，如：
5 d* `7 F5 V! ~  D; g! v

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

复制代码

7、SysStringByteLen求一个BSTR字符串的字节长度，如：
, \. ?: F0 u/ f0 a. @& l8 T

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

复制代码

8、SysAllocStringByteLen是按字节长度分配一个BSTR字符串。
/ L7 c# f; w" E8 p- `9 |% C以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
CComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
; A2 T# i2 a, i, Q. a# B( T1、构造一个CComBSTR对象

1. CComBSTR bstr1;
   % S3 }! s3 i; d$ j0 Q# j- t# `
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   
3. 
   
4. CComBSTR bstr2(L"this is a BSTR string");
   3 S7 A  y" Z. k" _0 f' ^
5. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK); 创建一个包含"this is a BSTR string"字符串的CComBSTR 对象
   + b2 h0 F! U' S( R
6. 
   4 q8 Z2 l% a" w% o' T* O
7. CComBSTR bstr3(5);
   ( Z& l: I$ v3 D$ j! {
8. MessageBox(NULL,bstr3.m_str ,L"bstr test",MB_OK);创建一个初始长度为5，含NULL的CComBSTR对象。
   & Y$ h1 I8 }1 n. D" L" X  @8 e8 j
9. 
   ; _% q9 k+ J1 n4 m9 A3 J$ D0 o
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对象，如：
) A3 M( u4 J6 B4 Q

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2(bstr1);
   
3. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK);

复制代码

最后的一个构造函数比较奇怪，他接受一个GUID参数，生成一个包含GUID字符串的CComBSTR对象，如：
8 ^# p% n6 F8 s

1. static const GUID GUID_Sample={0X8a44e110,0xf134,0x11d1,{0x96,0xb1,0xba,0xdb,0xba,0xdb,0xad,0xcc}};
   ) N" j2 k" q9 F5 `+ S
2. CComBSTR bstr1(GUID_Sample);
   * B  o1 h  F  N
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

2、CComBSTR定义的常用操作如下
( q9 ]. ?! |4 F6 q3 F' V) w（1）“=”操作符（赋值操作），如：

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2=bstr1;
   ( |7 W6 A5 f+ n! h( p& x: @
3. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);bstr2和bstr1包含相同内容。

复制代码

（2）BSTR操作符把CComBSTR对象显式的或隐式的转换成BSTR字符串，如:
! N, i% k- l+ L1 I" K1 b1 f

1. CComBSTR bstr1(L"this is a BSTR string");
   " ?6 ?" M/ H- a9 p
2. BSTR bstr2=bstr1;
   0 D9 U3 W7 |# J- |. E" i, W3 @
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对象，如：
' z+ W- R# U- s' K

1. CComBSTR bstr1(L"this is a BSTR string1");
   / `2 ]! y1 w3 R: Z; G
2. CComBSTR bstr2(L"this is a BSTR string2");
   ! R7 T. T! ^' X9 r" \  K9 n
3. if (bstr1!=bstr2){
   
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   7 ~/ y# z: Q3 t1 k! \3 {
5. }
   
6. else
   6 i3 Y) _& V. R* y3 P* D( S
7. {
   
8.         MessageBox(NULL,L"false",L"BSTR
   
9. test",MB_OK);
   
10. }

复制代码

3、CComBSTR定义的常用方法如下
6 s9 y. t; v/ F6 }' X7 X7 b（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来释放返回的字符串，如：
  I9 M$ N* c$ }: u& ^* x

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. BSTR bstr2;
   
3. bstr1.CopyTo(&bstr2);
   ( n5 ?5 g3 {& F! ^3 P
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（3）Attach方法把一个BSTR字符串附加到CComBSTR对象上，如：
& C0 V! Q) ^8 O+ _. g0 K7 B

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   9 R; K5 J9 V# [$ z" D
2. CComBSTR bstr2;
   
3. bstr2.Attach(bstr1);
   - C0 N6 n- p: p7 `" B& A
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：
1 e% Q' k3 g3 F% {9 p/ ^4 S+ X

1. bstr2.Detach ();

复制代码

（5）Empty 方法，释放对象中的BSTR字符串。 CComBSTR对象还有一些其它的方法，如附加字符串、大小写转换、对象持久性等并不常用。总之BSTR字符串是COM技术的基石，CComBSTR是处理BSTR字符串的利器，深入理解BSTR字符串是研究COM技术必须经过的关口。
$ J! X! Z6 ^' p0 e0 J, R6 a
3 w( [; y. ~" y