BSTR 字符串

天云上人

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

3 `, Z5 J2 A4 j( }( `& qBSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
+ b5 B, m  {, X0 n2 _; k对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：
4 e- X5 Q( b; p( W# y

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   , |4 s% T( X! s" X% ?
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);
   
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);
   0 O# g7 I4 E$ Q8 Q( Y9 j5 p
5. void SysFreeString(BSTR bstrString);
   
6. UINT SysStringLen(BSTR);
   + M6 K% ]) x: g6 b6 r2 W& x6 [
7. UINT SysStringByteLen(BSTR bstr);
   7 Y- N4 R& }% c3 \) T4 B, m
8. BSTR SysAllocStringByteLen(LPCSTR psz,UINT len);

复制代码

下面对上述API用法进行说明。
4 w5 n5 J. n5 h: @4 [
1、SysAllocString函数用于创建一个BSTR字符串，如：BSTR bstr=SysAllocString(L"create bstr string");就创建了一个BSTR字符串，上面说过BSTR字符串最初4个字节表示了字符串中字符个数，接下来是字符串中包含的真实字符，下面我们验证一下是否是这样的。我们生成一个WIN32控制台工程，生成时选择支持ATL的头文件，也可以后添加相应的头文件，主要是atlbase.h和atlstr.h，输入如下语句：
# {( A8 c0 i/ @; d( W
printf("bstr front 4 byte is %x",*((int*)(((int*)bstr-1))));
" I  b  J  o; _
# D: \9 F1 V/ h- }) h语句中的bstr是以上刚刚生成的BSTR组符串，此语句显示的结果是“bstr front 4 byte is 24”换算成10进制正好是34，是“create bstr string”长度的2倍因为BSTR字符串中的字符是用Unicode表示的，而语句

printf("bstr front 0 byte is %c",*((int*)((int*)bstr)));
2 w3 L: h+ Y- Y0 r5 i
4 c0 L5 H6 [" ]& ]$ U- k. B输出的是“c”是语句中的第一个字符，语句
, n, a4 ^% I& V' C1 w
5 S5 I9 i; |8 }6 i: ^printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。

4 w. D+ D- L' 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. SysReAllocString (&bstr,L"new string new string");   
   , K/ q0 H0 J; A2 x
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   " Q8 }2 a8 C9 A- ]- C
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字符串，例如：
- z- ^2 z9 ?7 j0 [: b1 i

1. BSTR bstr=SysAllocStringLen(L"create bstr string",6);   
   ( e- p+ E& h5 A9 }9 C
2. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));   
   $ E  M. G; K! o& {
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串。
- z: Z* F. c/ ~6 B: F8 |/ ]; \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))));
   9 {. ?5 D' w- d9 M
4. printf("bstr front 0 byte is %c\n",*((int*)((int*)bstr)));
   7 F! p  g) u1 ]' a
5. printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

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

1. SysFreeString(bstr);

复制代码

6、SysStringLen求一个BSTR字符串的长度，如：
4 I& _0 M! a" F8 P

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

复制代码

7、SysStringByteLen求一个BSTR字符串的字节长度，如：
. j5 ?# B- m' d) `5 I! N

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

复制代码

8、SysAllocStringByteLen是按字节长度分配一个BSTR字符串。
以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
/ |1 l2 \0 A, T' R/ DCComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
1、构造一个CComBSTR对象
# Q4 U; T. l" }6 E# L7 ]

1. CComBSTR bstr1;
   
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   
3. 
   9 P) f4 n$ p9 E1 l8 a
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 对象
   0 x& i6 g9 v! r+ Q4 K6 y
6. 
   8 J' l. U0 j3 l$ ?3 I4 y
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");
    . f$ L* o' q. z9 j- c1 u) S
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);
   : M; Q+ E5 N9 T2 `
3. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK);

复制代码

最后的一个构造函数比较奇怪，他接受一个GUID参数，生成一个包含GUID字符串的CComBSTR对象，如：
" C6 Y. A' [: d4 Z1 N4 z( X) R

1. static const GUID GUID_Sample={0X8a44e110,0xf134,0x11d1,{0x96,0xb1,0xba,0xdb,0xba,0xdb,0xad,0xcc}};
   + T  @2 Y8 Y$ o& ^* ^
2. CComBSTR bstr1(GUID_Sample);
   & C! ^; G; o+ z7 v# i( \! T3 v
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

2、CComBSTR定义的常用操作如下
& ?" E, C, f2 I0 ?; {$ [. T（1）“=”操作符（赋值操作），如：

1. CComBSTR bstr1(L"this is a BSTR string");
   8 C( A2 j8 W& |; U+ K
2. CComBSTR bstr2=bstr1;
   2 m: i) G" N* u2 s4 N7 w, t; W
3. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);bstr2和bstr1包含相同内容。

复制代码

（2）BSTR操作符把CComBSTR对象显式的或隐式的转换成BSTR字符串，如:

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. BSTR bstr2=bstr1;
   
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   9 r2 t9 W$ K" m8 [/ E# H7 Z
4. 
   ) _( [4 @: W5 @+ K7 n0 T$ Y
5. CComBSTR bstr1(L"this is a BSTR string");
   
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：
6 X  Z. K% M* Q& \7 D: I7 y# D

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. CComBSTR bstr2(L"this is a BSTR string2");
   ! t3 P' J! Z5 m1 B
3. if (bstr1!=bstr2){
   % R1 o" |7 w+ F( ~% B' v; u9 X
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   . l1 H6 x( g# T0 T8 [
5. }
   ; K: z+ v4 U3 G. q5 p2 N. x
6. else
   - K3 b; y$ d6 N$ j
7. {
   . h/ i# N/ \4 h3 p
8.         MessageBox(NULL,L"false",L"BSTR
   
9. test",MB_OK);
     _' i" O; I: J! b
10. }

复制代码

3、CComBSTR定义的常用方法如下
（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：
- ]7 K- p: p- g7 e2 I& s& M* o

1. CComBSTR bstr1(L"this is a BSTR string1");
   / Y9 A, m! ~6 L7 t) a
2. BSTR bstr2=bstr1.Copy ();
   , {% O4 ]/ N4 ?( N: H
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string1");
   / W2 s' X, j/ O' E& J
2. BSTR bstr2;
   5 y! F2 O" |0 o( f. C; j
3. bstr1.CopyTo(&bstr2);
   # |) A% f! t0 o6 r( K  Q: }
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

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

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   
2. CComBSTR bstr2;
   * R' q1 H3 I; s& Y8 b" S
3. bstr2.Attach(bstr1);
   
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：
4 C, d9 Y$ c; `+ R

1. bstr2.Detach ();

复制代码

（5）Empty 方法，释放对象中的BSTR字符串。 CComBSTR对象还有一些其它的方法，如附加字符串、大小写转换、对象持久性等并不常用。总之BSTR字符串是COM技术的基石，CComBSTR是处理BSTR字符串的利器，深入理解BSTR字符串是研究COM技术必须经过的关口。
+ _, I9 S7 x" P. t# Q