BSTR 字符串

天云上人

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

* h. x* G1 z) ^1 i+ QBSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
; w2 D( \5 a! G8 W对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：
4 n7 D: B! r5 Y8 Y* A

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   
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);
   ) V) u( C9 }' |
2. INT  SysReAllocString(BSTR* pbstr,const OLECHAR* psz);
   
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   2 s) s6 B' n. T9 i
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   
5. void SysFreeString(BSTR bstrString);
   
6. UINT SysStringLen(BSTR);
   8 L5 T. I! Y% `. P1 T5 X" u
7. UINT SysStringByteLen(BSTR bstr);
   
8. BSTR SysAllocStringByteLen(LPCSTR psz,UINT len);

复制代码

下面对上述API用法进行说明。
3 D4 x6 J* u5 [* D/ q0 y
7 ]8 X3 m8 p) _* w1、SysAllocString函数用于创建一个BSTR字符串，如：BSTR bstr=SysAllocString(L"create bstr string");就创建了一个BSTR字符串，上面说过BSTR字符串最初4个字节表示了字符串中字符个数，接下来是字符串中包含的真实字符，下面我们验证一下是否是这样的。我们生成一个WIN32控制台工程，生成时选择支持ATL的头文件，也可以后添加相应的头文件，主要是atlbase.h和atlstr.h，输入如下语句：
  H( L. @0 D2 j8 U4 V
$ F) `3 F, z- Eprintf("bstr front 4 byte is %x",*((int*)(((int*)bstr-1))));
3 n5 H, t. v. O& p* v( ~
9 \0 i0 `, L% f语句中的bstr是以上刚刚生成的BSTR组符串，此语句显示的结果是“bstr front 4 byte is 24”换算成10进制正好是34，是“create bstr string”长度的2倍因为BSTR字符串中的字符是用Unicode表示的，而语句
1 f5 E6 I$ Y' B+ p; n
$ I6 y7 P9 V1 pprintf("bstr front 0 byte is %c",*((int*)((int*)bstr)));
, ]( `" b3 n& E- s/ [% U
, `+ l+ v8 f; O4 a2 x5 p  u8 I输出的是“c”是语句中的第一个字符，语句
1 D' B* S& C/ F% b# H' k  t+ x
' P9 W+ t! R7 K6 mprintf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));
! V9 D0 I" B6 ?9 @1 N
输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。
# s* O7 `% t# p8 e
" Z$ I$ z- ~: i, w0 Y3 g2、SysReAllocString用于在一个已有的BSTR字符串的基础上重新建立一个BSTR字符串，输入如下的语句，可以检测该函数使用后的效果：
# B9 ]0 B1 F% a7 _5 D$ @

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))));
   ! }  x. ]/ M) ?5 G6 E" e& D
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   , O  R8 Y: H# y3 \; s/ L+ E
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所指出的长度范围。但如果新的字符串如果超出原来串的长度，那么原来的字符串将被全部覆盖，长度以新的字符串为准，下面的语句说明了这一点。  
( k; l& K% }! R" U! M7 c

1. SysReAllocString (&bstr,L"new string new string");   
   * R" D2 c4 e1 a5 j& Z+ Y$ N# ?
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   $ X6 g6 u  t/ Y8 K
3. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   , }2 g, w8 z* ~! l0 D; s" [
4. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

3、SysAllocStringLen按照指定的长度分配一个BSTR字符串，例如：
' C+ M4 T2 p  Y" `+ s' m! B- ^

1. BSTR bstr=SysAllocStringLen(L"create bstr string",6);   
   
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   $ B: s3 G! q8 ~* _8 C0 \8 ]: R
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字符串。如：
+ W; @/ Q3 u5 A% ?$ k

1. BSTR bstr=SysAllocString(L"create bstr string");   
   
2. SysReAllocStringLen(&bstr,L"new string",3);
   8 N) J7 f1 v# Q6 Z" e% c
3. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));
   4 R- R1 \" ]1 j1 G& W
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) s6 `4 j( b. d, e

1. SysFreeString(bstr);

复制代码

6、SysStringLen求一个BSTR字符串的长度，如：
! ~! _: J/ z! F2 I

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字符，下面大致说说该类的用法。
7 ?+ l7 Z, C$ iCComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
( {% p, {9 A- ~7 ~' h6 b) Z1、构造一个CComBSTR对象

1. CComBSTR bstr1;
   8 A6 W  J. T0 Y9 y9 o& N
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对象。
   
9. 
   - ?& ~- d9 s5 c! e% d! X# v# t
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对象，如：

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2(bstr1);
   8 y4 P" `0 p: n( J# u' i) J. F( y
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);
   4 E7 `! t' I* Z2 k  f* n8 D- w8 O
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string");
   6 [$ b% t8 A5 Z; V9 y
2. CComBSTR bstr2=bstr1;
   
3. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);bstr2和bstr1包含相同内容。

复制代码

（2）BSTR操作符把CComBSTR对象显式的或隐式的转换成BSTR字符串，如:
, Q% A. p: P# s* e' }$ h4 a( ~

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. BSTR bstr2=bstr1;
   8 w! Z4 K& L: w% g* R9 ]$ K
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   8 u, \/ q6 Q5 K+ S% _/ z  R
4. 
   1 U. ?8 t4 ^- l) t# ^4 c
5. CComBSTR bstr1(L"this is a BSTR string");
   0 J3 j( M; r3 f! r  ]
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：
2 h6 y; w* H. o, M8 e1 c

1. CComBSTR bstr1(L"this is a BSTR string1");
   4 F6 g! l, q% v( i% t1 g0 E/ E0 x
2. CComBSTR bstr2(L"this is a BSTR string2");
   5 a2 Z7 ^2 z: S5 |7 H- W& G$ L$ r
3. if (bstr1!=bstr2){
   
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   * N* h/ ?- s5 T- ]
5. }
   
6. else
   " \; V7 @; J2 D# z, ]; a
7. {
   
8.         MessageBox(NULL,L"false",L"BSTR
   
9. test",MB_OK);
   6 ~$ F, {# G% e0 Q  E3 ~: o; o& G
10. }

复制代码

3、CComBSTR定义的常用方法如下
5 `. ]( Y* E" R3 {* y（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：
, B! X9 W' W1 ?( |( g* c

1. CComBSTR bstr1(L"this is a BSTR string1");
   * J. z+ t0 o; g- w. z( q
2. BSTR bstr2=bstr1.Copy ();
   - Y9 Y4 r- J% o9 M" D) n) w7 B
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string1");
   - V4 C1 f* |  r+ x
2. BSTR bstr2;
   + C$ l+ [; V+ Q" t9 w! p, Z8 T
3. bstr1.CopyTo(&bstr2);
   5 J3 m9 J& s4 V$ L: Q! b
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（3）Attach方法把一个BSTR字符串附加到CComBSTR对象上，如：
( @7 q0 m# b+ Y* P; V7 E

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   3 T/ L! G" `0 @: v) U- [" y' k
2. CComBSTR bstr2;
   
3. bstr2.Attach(bstr1);
   . m% i" _- E$ r# V0 Y" n* n
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：
  a  S/ T& F+ w+ ~6 A7 C

1. bstr2.Detach ();

复制代码

（5）Empty 方法，释放对象中的BSTR字符串。 CComBSTR对象还有一些其它的方法，如附加字符串、大小写转换、对象持久性等并不常用。总之BSTR字符串是COM技术的基石，CComBSTR是处理BSTR字符串的利器，深入理解BSTR字符串是研究COM技术必须经过的关口。
) \) `" \6 f% t  T
7 p( U- }" b# x5 Q7 j9 I