BSTR 字符串

天云上人

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

" H/ U% u% Q9 c" O6 pBSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：
. H5 I  d* {! F! t7 x

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);
   . G& t9 C+ @+ N/ b6 V3 v, X
2. INT  SysReAllocString(BSTR* pbstr,const OLECHAR* psz);
   
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   5 r$ A: s7 z7 D9 F. b1 H
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   : L5 w, ]! }# \; m3 S9 P/ A+ I
5. void SysFreeString(BSTR bstrString);
   
6. UINT SysStringLen(BSTR);
   . V0 ]% j: [; _$ C% e
7. UINT SysStringByteLen(BSTR bstr);
   
8. BSTR SysAllocStringByteLen(LPCSTR psz,UINT len);

复制代码

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

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

$ k8 ^8 ~9 E* c6 _- Tprintf("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表示的，而语句
- n" q  a7 k4 N# x% y$ z
1 M( D+ B6 d7 V4 ]! }* n( Vprintf("bstr front 0 byte is %c",*((int*)((int*)bstr)));
" P) s6 z8 R, ]$ u7 @- g; E1 h! }! o
! y7 @9 p# `$ P* `$ E8 h2 Q9 P7 F输出的是“c”是语句中的第一个字符，语句
9 @4 r: j5 I+ r8 Z! ?& f
/ ]) z. K  _$ ]. e8 B5 H" C( zprintf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));
, U! n" z5 r% X# i
3 E) H3 P0 F* q6 m0 d, S输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。
2 z1 I; R# u! ]0 p/ P' z
: |( q$ [6 B5 V: }/ [2、SysReAllocString用于在一个已有的BSTR字符串的基础上重新建立一个BSTR字符串，输入如下的语句，可以检测该函数使用后的效果：
1 n7 a, D9 y: h# n5 ]  Q' T

1. BSTR bstr=SysAllocString(L"create bstr string");   
   ' j. [4 P" n. w; a0 I. n% M; @4 P& L
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)));
   ( m% x' M& ~, H! O$ f5 x9 S* W
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");   
   . W' k& D* F) k" w7 z
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)));
   / i6 c; G( a3 {( @
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);   
   
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)));printf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

复制代码

虽然“create bstr string”的长度是18个字符但此语句只分派6个字符的BSTR串。
4、SysReAllocStringLen函数是在已有的字符串的基础上按指定长度重新分配一个新的BSTR字符串。如：
  R. Y% s# X( q: n; [

1. BSTR bstr=SysAllocString(L"create bstr string");   
   
2. SysReAllocStringLen(&bstr,L"new string",3);
   # @, U, b# F  }2 ~
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字符串的长度，如：
( N8 P4 j) i, O

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

复制代码

7、SysStringByteLen求一个BSTR字符串的字节长度，如：
% Q$ M) u& f* T; S- s

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

复制代码

8、SysAllocStringByteLen是按字节长度分配一个BSTR字符串。
9 J% X, Z8 e" R$ W' \2 ]以上大致就是BSTR API 的用法，为了方便操作BSTR字符串，在ATL中建立了CComBSTR类专门用于操作BSTR字符，下面大致说说该类的用法。
CComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
1、构造一个CComBSTR对象

1. CComBSTR bstr1;
   
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   * B2 y. f+ T% |0 P: Z) M
3. 
   9 ^6 [  H1 ?# H
4. CComBSTR bstr2(L"this is a BSTR string");
   3 ~+ @# |$ z3 I9 A; ?: u& ~& P
5. MessageBox(NULL,bstr2.m_str ,L"bstr test",MB_OK); 创建一个包含"this is a BSTR string"字符串的CComBSTR 对象
   ! `/ z* m  z; h" o- ]* O
6. 
   
7. CComBSTR bstr3(5);
   " w* c' i" |7 j7 `+ t: k
8. MessageBox(NULL,bstr3.m_str ,L"bstr test",MB_OK);创建一个初始长度为5，含NULL的CComBSTR对象。
   
9. 
   1 ~/ x& R4 A1 L& o2 E9 @. d
10. CComBSTR bstr4(3,L"this is a BSTR string");
    # x' c' e) Q5 s, T1 c5 L4 q; l
11. MessageBox(NULL,bstr4.m_str ,L"bstr test",MB_OK);创建一个长度为3的CComBSTR对象，后面的字符串舍去。

复制代码

我们也可以从一个已经存在的CComBSTR对象创建另一个CCOmBSTR对象，如：

1. CComBSTR bstr1(L"this is a BSTR string");
   - t6 k# a4 @% n. N
2. CComBSTR bstr2(bstr1);
   " I$ [, o+ k  f- M" i, n
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}};
   ! L" D' h: b+ |
2. CComBSTR bstr1(GUID_Sample);
     ~; r; H! A1 r& t! I
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2=bstr1;
   6 F. X' A9 _; I4 N6 [
3. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);bstr2和bstr1包含相同内容。

复制代码

（2）BSTR操作符把CComBSTR对象显式的或隐式的转换成BSTR字符串，如:
/ s6 N- t  u7 f5 @6 h

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. BSTR bstr2=bstr1;
   
3. MessageBox(NULL,bstr2 ,L"BSTR test",MB_OK);隐式转换
   3 P3 L0 A1 F1 E4 ?
4. 
   ; I: V" p# w! K' @! H; c- g
5. CComBSTR bstr1(L"this is a BSTR string");
   ( F" l7 O4 ]" }* s3 N
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：

1. CComBSTR bstr1(L"this is a BSTR string1");
   0 t! e7 X! O+ d- c. t
2. CComBSTR bstr2(L"this is a BSTR string2");
   1 l; t0 h2 ~* J6 f$ }1 F' w7 @
3. if (bstr1!=bstr2){
   4 f) y3 v( V$ W7 T  c3 ^
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   * ?. }& V# l1 }
5. }
   & a6 Z4 Z6 V$ J" {5 D1 B
6. else
   - V5 r2 _6 b, x/ n- z% {" i0 I/ w
7. {
   
8.         MessageBox(NULL,L"false",L"BSTR
   . ^- A' o: _7 s6 d5 y* E4 B0 E
9. test",MB_OK);
   
10. }

复制代码

3、CComBSTR定义的常用方法如下
（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：
" R- x, a4 K* w3 K) a/ B$ `$ u

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. BSTR bstr2=bstr1.Copy ();
   1 P# F7 T4 p+ X
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string1");
   . w- A4 t8 }$ ~4 B5 a- J2 ^# Q
2. BSTR bstr2;
   . B  B) |7 |3 {) P
3. bstr1.CopyTo(&bstr2);
   ' c0 g* S; k% B4 c+ J
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（3）Attach方法把一个BSTR字符串附加到CComBSTR对象上，如：
- l- P9 M! C. H0 D* e

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   
2. CComBSTR bstr2;
   / R( J4 _$ g" x  L. e/ A
3. bstr2.Attach(bstr1);
   ( X7 C- {$ K" a
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：
( a' P1 g) u+ i9 _8 S1 B

1. bstr2.Detach ();

复制代码

（5）Empty 方法，释放对象中的BSTR字符串。 CComBSTR对象还有一些其它的方法，如附加字符串、大小写转换、对象持久性等并不常用。总之BSTR字符串是COM技术的基石，CComBSTR是处理BSTR字符串的利器，深入理解BSTR字符串是研究COM技术必须经过的关口。
, G5 Q- m; R' ^6 L# _7 z
  }) {5 O1 z6 g  d+ J# T/ G