BSTR 字符串

天云上人

原文：http://www.vckbase.com/document/viewdoc/?id=1911
( F, ]4 J8 ]2 I+ v; y4 V
BSTR是“Basic String”的简称，微软在COM/OLE中定义的标准字符串数据类型。
3 y. E8 n4 r7 p对于VC++，Windows头文件wtypes.h和WinNT.h中定义如下：

1. typedef /* [wire_marshal] */ OLECHAR *BSTR;
   " c  s9 n% ?  j: \1 f2 v
2. typedef WCHAR OLECHAR;
   2 R6 w( S9 b( |. Y  P/ \
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);
   " Z0 A+ O( u/ G1 ^9 I$ A
2. INT  SysReAllocString(BSTR* pbstr,const OLECHAR* psz);
     u4 j$ m4 b: D0 {
3. BSTR SysAllocStringLen(const OLECHAR * strIn, UINT ui);
   ( m4 v; \" k; m8 D( S8 [
4. INT  SysReAllocStringLen(BSTR* pbstr,const OLECHAR* psz,unsigned int len);
   1 Y* d/ o6 {9 X7 z3 ~- ~- M
5. void SysFreeString(BSTR bstrString);
   5 r6 n0 `4 M( b- `+ M
6. UINT SysStringLen(BSTR);
   0 \+ E3 l/ U0 B% m: Z( T
7. UINT SysStringByteLen(BSTR bstr);
   & Z) H7 c7 ?/ ^/ b2 W. H
8. BSTR SysAllocStringByteLen(LPCSTR psz,UINT len);

复制代码

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

. ?* @% _5 i+ eprintf("bstr front 4 byte is %x",*((int*)(((int*)bstr-1))));
1 n7 V2 {& C% h, R
1 s: {* |6 m+ B% [! s6 W; v$ R语句中的bstr是以上刚刚生成的BSTR组符串，此语句显示的结果是“bstr front 4 byte is 24”换算成10进制正好是34，是“create bstr string”长度的2倍因为BSTR字符串中的字符是用Unicode表示的，而语句

9 y" p( i7 M4 Dprintf("bstr front 0 byte is %c",*((int*)((int*)bstr)));

输出的是“c”是语句中的第一个字符，语句

" l, b+ f: L" r) W2 k8 j8 iprintf("bstr front 35 byte is %c\n",*((char*)(((char*)bstr+34))));

3 N( B. L6 }( M: K& w) k输出的是“g”语句中的最后一个字符，以上说明了SysAllocString函数用法及BSTR字符串在内存中的存储格式。

2、SysReAllocString用于在一个已有的BSTR字符串的基础上重新建立一个BSTR字符串，输入如下的语句，可以检测该函数使用后的效果：

1. BSTR bstr=SysAllocString(L"create bstr string");   
   , d  M' b$ 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)));
   " n8 k- w( `4 ?/ Z
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");   
   5 l# `* M6 T; O: p
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字符串，例如：
/ I& l7 L4 ~$ p" ]

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串。
: G7 G8 j. @) L4、SysReAllocStringLen函数是在已有的字符串的基础上按指定长度重新分配一个新的BSTR字符串。如：
, T2 ?2 r) c6 h7 }/ a

1. BSTR bstr=SysAllocString(L"create bstr string");   
   / [: z) ?& u# ~
2. SysReAllocStringLen(&bstr,L"new string",3);
   + p7 u, C& @: y+ l1 q0 E
3. printf("bstr front 4 byte is %x\n",*((int*)(((int*)bstr-1))));
   . ]5 x! w+ @% X3 r
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字符串用后必须用此函数进行释放，例如：
+ p* ^' f0 O2 v+ ]

1. SysFreeString(bstr);

复制代码

6、SysStringLen求一个BSTR字符串的长度，如：
+ o' e3 C+ M$ r/ X6 C# C4 K

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字符，下面大致说说该类的用法。
. g5 ~, S9 e$ |1 K8 R# T2 ~CComBSTR类维护了公有的BSTR类型成员变量m_str，定义了8个构造函数用于创建CComBSTR对象，在析构函数中释放了m_str,在类中定义了常用的操作符并提供了对象持久性支持。
) b( t3 y5 H% P8 S/ Y0 ^1、构造一个CComBSTR对象

# s. @0 z' r7 @8 K3 L% E

1. CComBSTR bstr1;
   " L) e7 c% K- u8 E; p, m# L
2. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK); 创建一个空的CComBSTR 对象
   7 @5 D! }3 {1 X- k1 P+ z
3. 
   0 J( D  v' m# H
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. 
   " W8 l3 Z" f$ L" |0 R
7. CComBSTR bstr3(5);
   . D' m3 i* l0 o5 ]1 L1 c  U
8. MessageBox(NULL,bstr3.m_str ,L"bstr test",MB_OK);创建一个初始长度为5，含NULL的CComBSTR对象。
   
9. 
   ' N6 @6 a) ^7 J' w1 [
10. CComBSTR bstr4(3,L"this is a BSTR string");
    & B  U- y/ @. w+ W
11. MessageBox(NULL,bstr4.m_str ,L"bstr test",MB_OK);创建一个长度为3的CComBSTR对象，后面的字符串舍去。

复制代码

我们也可以从一个已经存在的CComBSTR对象创建另一个CCOmBSTR对象，如：
1 v3 M" }# O5 p% r  Z5 Y

1. CComBSTR bstr1(L"this is a BSTR string");
   5 k9 u0 `# \; u; ]" Q+ n
2. CComBSTR bstr2(bstr1);
   & M$ I- ?/ X8 A7 {. F' n9 {: E9 M  {
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}};
     z* I$ s+ ?$ V) i  N) _
2. CComBSTR bstr1(GUID_Sample);
   
3. MessageBox(NULL,bstr1.m_str ,L"bstr test",MB_OK);

复制代码

2、CComBSTR定义的常用操作如下
9 n% ?: z% _% M3 O, ]& v* T; x（1）“=”操作符（赋值操作），如：
/ y8 j, k  f, `: p# f. ?

1. CComBSTR bstr1(L"this is a BSTR string");
   
2. CComBSTR bstr2=bstr1;
   
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);隐式转换
   
4. 
   0 l9 S- D8 [* G' V
5. CComBSTR bstr1(L"this is a BSTR string");
   $ M; }' F/ m6 e+ ^  D
6. MessageBox(NULL,(BSTR)bstr1 ,L"BSTR test",MB_OK);显式转换

复制代码

（3）！= 操作符，用来直接比较两个CComBSTR对象，如：
) W  E2 \: R$ p" W8 W  B$ U

1. CComBSTR bstr1(L"this is a BSTR string1");
   
2. CComBSTR bstr2(L"this is a BSTR string2");
   
3. if (bstr1!=bstr2){
   
4.         MessageBox(NULL,L"true",L"BSTR test",MB_OK);
   ; \7 r3 q; z7 T( R1 s
5. }
   / q0 l: B! b& t# Z- P5 t3 l
6. else
   
7. {
   : r0 |+ K, J6 U- H2 {( h
8.         MessageBox(NULL,L"false",L"BSTR
   / k4 u+ }- C/ [/ k
9. test",MB_OK);
   
10. }

复制代码

3、CComBSTR定义的常用方法如下
5 n' H$ @" \5 }7 |（1）Copy 方法，该方法拷贝CComBSTR对象中的BSTR字符串并返回BSTR字符串，如：

1. CComBSTR bstr1(L"this is a BSTR string1");
   & v  B% |2 b- i, Z
2. BSTR bstr2=bstr1.Copy ();
   3 z* p4 h0 e2 J/ i+ N
3. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

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

1. CComBSTR bstr1(L"this is a BSTR string1");
   8 R3 U5 w9 X1 X0 |
2. BSTR bstr2;
   
3. bstr1.CopyTo(&bstr2);
   2 Q4 n3 i, P6 W
4. MessageBox(NULL,bstr2,L"BSTR test",MB_OK);

复制代码

（3）Attach方法把一个BSTR字符串附加到CComBSTR对象上，如：
/ S; G) q. d# ]" j; O

1. BSTR bstr1=::SysAllocString (L"this is a BSTR string");
   ( G" w1 j7 p& E/ U+ e/ v
2. CComBSTR bstr2;
   $ @, `) ~& Y5 g1 t5 [) @
3. bstr2.Attach(bstr1);
   3 Q4 E! t( c8 ?( I. `
4. MessageBox(NULL,bstr2.m_str ,L"BSTR test",MB_OK);

复制代码

（4）Detach方法分离BSTR字串与CComBSTR对象，用法：
, W' w1 r1 T' p+ D

1. bstr2.Detach ();

复制代码

（5）Empty 方法，释放对象中的BSTR字符串。 CComBSTR对象还有一些其它的方法，如附加字符串、大小写转换、对象持久性等并不常用。总之BSTR字符串是COM技术的基石，CComBSTR是处理BSTR字符串的利器，深入理解BSTR字符串是研究COM技术必须经过的关口。
, n' w+ J0 s/ j' |7 S
, ?8 c' s# f! ^6 Y% n4 N- |' o  s" v