BSTR 字符串

天云上人

原文：http://www.vckbase.com/document/viewdoc/?id=1911
! v6 J9 j$ f  J* ?$ T
4 q# H# ]/ n% Q! \# M7 oBSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：
4 J  N3 z9 l$ d- @1 {

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   
2. typedef WCHAR OLECHAR;
   0 w% d8 q% j$ E
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 ]# \; t  O; P' P
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   + F4 W, j- S. H# u
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   * ]" o" C& Y* m8 z0 |4 p
5. void SysFreeString(BSTR bstrString);
   
6. UINT SysStringLen(BSTR);
   
7. UINT SysStringByteLen(BSTR bstr);
   & ?2 \& J1 `" E2 F5 k
8. BSTR SysAllocStringByteLen(LPCSTR psz,UINT len);

复制代码

下面对上述API用法进行说明。
" L) r9 G0 ?4 U( j3 R* e5 M1 {; @
0 e; F2 B: f, V+ t1、SysAllocString函数用于创建一个BSTR字符串，如：BSTR bstr=SysAllocString(L"create bstr string");就创建了一个BSTR字符串，上面说过BSTR字符串最初4个字节表示了字符串中字符个数，接下来是字符串中包含的真实字符，下面我们验证一下是否是这样的。我们生成一个WIN32控制台工程，生成时选择支持ATL的头文件，也可以后添加相应的头文件，主要是atlbase.h和atlstr.h，输入如下语句：
) D6 `3 \. e% p$ W
printf("bstr front 4 byte is %x",*((int*)(((int*)bstr-1))));
6 X0 v- J! g: X8 E# U8 r4 X
' @! n& F: W& J8 a) k) j语句中的bstr是以上刚刚生成的BSTR组符串，此语句显示的结果是“bstr front 4 byte is 24”换算成10进制正好是34，是“create bstr string”长度的2倍因为BSTR字符串中的字符是用Unicode表示的，而语句
7 M6 V5 u0 j5 ?1 V" }: v
6 }7 F9 c2 i6 b* Z' jprintf("bstr front 0 byte is %c",*((int*)((int*)bstr)));
3 y8 n' j$ \( y" h9 H; e4 W
输出的是“c”是语句中的第一个字符，语句

printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。
9 o: P$ h6 N& p+ O' @+ p; ?
$ b; h' H" Y6 f2、SysReAllocString用于在一个已有的BSTR字符串的基础上重新建立一个BSTR字符串，输入如下的语句，可以检测该函数使用后的效果：

1. BSTR bstr=SysAllocString(L"create bstr string");   
   * r! V4 t  E* u- V1 Q9 p) _
2. SysReAllocString (&bstr,L"new string");printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));
     Z4 q$ R5 B6 z8 X
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");   
   & x! N/ N. }& k
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)));
   
4. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

3、SysAllocStringLen按照指定的长度分配一个BSTR字符串，例如：
6 A4 k$ w7 U( g8 n8 ^# z

1. BSTR bstr=SysAllocStringLen(L"create bstr string",6);   
   
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   ! z- A% [4 v2 \1 ~% E
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字符串。如：
' _5 |5 K: L- F6 F

1. BSTR bstr=SysAllocString(L"create bstr string");   
   : U( _0 m; D7 `3 r# N. o" _8 z" `
2. SysReAllocStringLen(&bstr,L"new string",3);
   7 {8 e) H5 S! o3 z0 H- V
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字符串用后必须用此函数进行释放，例如：
, S% Z0 S/ p0 O( g4 k8 i7 u, |( g

1. SysFreeString(bstr);

复制代码

6、SysStringLen求一个BSTR字符串的长度，如：
: A( ]# G& N6 Z& y! ^7 d' V# s2 k

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

复制代码

7、SysStringByteLen求一个BSTR字符串的字节长度，如：
3 T& C5 ]2 [: j7 K) Z

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

复制代码

8、SysAllocStringByteLen是按字节长度分配一个BSTR字符串。
以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
' I! h4 ]$ O) U4 s  T, ECComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
* B0 w/ g' x1 B/ b; D0 r1、构造一个CComBSTR对象

1. CComBSTR bstr1;
     q7 _: R: i0 q. K. }2 E3 ?
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   
3. 
   
4. CComBSTR bstr2(L"this is a BSTR string");
   + O4 j. i' Q) `4 H0 N
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. 
   
10. CComBSTR bstr4(3,L"this is a BSTR string");
    ' o  \' w) z6 M4 ^5 j+ T- h" i
11. MessageBox(NULL,bstr4.m_str ,L"bstr test",MB_OK);创建一个长度为3的CComBSTR对象，后面的字符串舍去。

复制代码

我们也可以从一个已经存在的CComBSTR对象创建另一个CCOmBSTR对象，如：
4 n7 a0 N6 v* N* S1 k3 W9 c) h

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 u: k- b3 ^. D

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定义的常用操作如下
5 C3 N0 y, U% a- ^$ Q（1）“=”操作符（赋值操作），如：
  G1 @7 v1 y, x6 L0 ^8 Y/ a- k

1. CComBSTR bstr1(L"this is a BSTR string");
   , G( A; o0 {( y' ~9 Y; Z- ?3 w8 e6 `
2. CComBSTR bstr2=bstr1;
   
3. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);bstr2和bstr1包含相同内容。

复制代码

（2）BSTR操作符把CComBSTR对象显式的或隐式的转换成BSTR字符串，如:
4 A# X$ l  r. \9 a3 L, D/ Z/ Q

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. BSTR bstr2=bstr1;
   ' \; N0 z8 V$ V! D
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   0 N0 j, J% E( a" D
4. 
   1 \! W4 {" m) I5 W
5. CComBSTR bstr1(L"this is a BSTR string");
   
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：
9 u3 E# k) [- {6 {# c0 ~% ]

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. CComBSTR bstr2(L"this is a BSTR string2");
   ; F$ _: D- s+ {0 _
3. if (bstr1!=bstr2){
   
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   # b! N8 U0 {5 ]" V6 V+ w0 Q; Y
5. }
   
6. else
   ( G: n% v2 |5 U
7. {
   ! V5 l! R2 e; |8 {& b
8.         MessageBox(NULL,L"false",L"BSTR
   : V2 _; x, Q7 @3 R! }/ ?
9. test",MB_OK);
   
10. }

复制代码

3、CComBSTR定义的常用方法如下
; l& N7 ?- M9 k8 N' u* ?2 E' l（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：
6 @: Y4 s' L% k0 F6 H! E/ J2 Q

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. BSTR bstr2=bstr1.Copy ();
   , b9 K( q7 \" X& E2 ^: q- `" x$ P
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string1");
   / \, E! p2 [3 j- I
2. BSTR bstr2;
   , A. @' P4 T$ o" i6 Z* \" [
3. bstr1.CopyTo(&bstr2);
   
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（3）Attach方法把一个BSTR字符串附加到CComBSTR对象上，如：
+ Z: k2 ]0 P* @7 G, l# l; s% {

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   & v5 z/ ~" ^+ [. N9 R+ o) F
2. CComBSTR bstr2;
   ; ?! y# Y7 j" v+ Q9 w, M+ j
3. bstr2.Attach(bstr1);
   
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技术必须经过的关口。

$ s( @8 n& R$ f( o