BSTR详解一 - BSTR简介和内部结构

逍遥公子

1  Why need BSTR
COM是一种跨编程语言的平台，需要提供语言无关的数据类型。多数编程语言有自己的字符串表示。

• C++ 字符串是以0结束的ASCII或Unicode字符数组
• Visual Basic字符串是一个ASCII字符数组加上表示长度的前缀。
• Java字符串是以0结束的Unicode字符数组。

需要定义一种通用的字符串类型，可以很容易的匹配到不同编程语言。在C++中，就是BSTR。


2   What is BSTR

2.1  BSTR 简介
"Basic STRing"的简称，微软在COM/OLE中定义的标准字符串数据类型。对于C++，Windows头文件wtypes.h中定义如下：
typedef wchar_t WCHAR;
typedef WCHAR OLECHAR;
typedef OLECHAR __RPC_FAR *BSTR;;


2.2  BSTR实现
在COM中，字符用16-bit OLECHAR表示，这样使COM可以支持各种code pages，包括Unicode。对于windows系统，可以简单理解为OLECHAR使用的就是Unicode 。OLECHAR串与单字节字符串很类似，是一个以null结尾的buffer。唯一的区别是每个字符占两个字节，而不是一个

0 1 2 3 4 5 6 7 8 9 0 1
| H | E | L | L | O | /0|
^
OLCHAR


Figure 1. Format of an OLECHAR string.

使用以Null结尾的简单字符串在COM component间传递不太方便。因此，标准BSTR是一个有长度前缀和null结束符的OLECHAR数组。BSTR的前4字节是一个表示字符串长度的前缀。BSTR长度域的值是字符串的字节数，并且不包括0结束符。由于是Unicode串，所以字符数是字节数的一半。这种方式的优点是允许程序员在BSTR串中间嵌入NULL字符。但是，BSTR的前四个字节表示长度，而OLECHAR数组的前四字节表示前两个字符。这种情况下，对于C++程序，如何实现BSTR和OLECHAR的交换？答案是COM提供了两个BSTR分配用的API：SysAllocString / SysReallocString。函数返回的指针指向BSTR的第一个字符，而不是BSTR在内存的第一个字节。


0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
0a000000 | H | E | L | L | O | /0|
         ^
         BSTR



Figure 2.  Format of a BSTR.

下面是SysAllocString和SysFreeString的伪代码。

BSTR SimpleSysAllocString( const OLECHAR * sz)
{
    if ( sz == NULL) return NULL;


    BYTE* buf = new BYTE[sizeof(INT32) + (wcslen(sz)+1)*sizeof(OLECHAR) ];


    if(buf == NULL)
    {
        return NULL;
    }
    else
    {
        INT32 len = wcslen(sz) * sizeof(OLECHAR);
        *((INT32*) buf) = len;
        wcscpy( (WCHAR*)(buf+sizeof(INT32)), sz);
        return (BSTR)(buf+sizeof(INT32));
    }
}


VOID SimpleSysFreeString( BSTR bstr)
{
    if(bstr != NULL)
    {
       BYTE* start = (BYTE*)bstr - sizeof(INT32);
       delete []start;
    }
}