JavaScript与ActiveX之间传递数据 - 连载二

本文研究如何在JS等脚本语言与ActiveX控件之间通信，如何传递各种类型的参数，以及COM的IDispatch接口。使用类似的方法，可以推广到其他所有脚本型语言，如LUA，AutoCad等。

本文将研究以下几个方面:

1. 整型数组传参
2. 字符串参数，字符串返回值
3. 修改传入字符串内容
4. 数组参数
5. IDisliatch接口介绍
6. 修改输入数组内容
7. 增加数组内容
8. 以数组传参方式，JS调用S4Execute( )

由于本文篇幅较长,所以将以连载方式进行发表,连载一主要讨论1-3点,连载二主要讨论4-6点,连载三主要讨论7-8点.

（四）数组参数

1. 在使用时，有时需要使用数组传参，如S4Execute()的inBuff/ outBuff。

2. JS中整型数据不分Byte/ Short/ Int等，因此数组元素类型都为int （COM中的VT_I4，其中I表示整型、4表示4字节）

3. JS中的Array在COM中是一个实现了IDispatch的对象，可通过IDispatch接口api进行操作。关于IDispatch请看下一节介绍。

4. COM中C++定义

下面代码中定义了两个函数 GetArrayNumberOfIndex、GetArrayLength两个函数，功能分别获取数组长度和获取指定序号元素

以下代码含义，请参考下一节 “IDispatch接口介绍”

JS数组在COM中是一个IDispatch对象，获取长度，实际是获取其中名为“length”的属性值。

而获取最后一个数组，实际是获取名为“4”的属性值（假设5个元素）

STDMETHODIMP CJsAtl::GetLastElement(VARIANT vArray, LONG* retVal)
{
         int len = 0;
         HRESULT hr = GetArrayLength(vArray.pdispVal, &len);
         if (FAILED(hr))
                  return hr;
 
         hr = GetArrayNumberOfIndex(vArray.pdispVal, len - 1, retVal);
         return S_OK;
}
// ***
// 获取Javascript数组长度
//       Javascript中的数组length只计算列表中下标为数字的部分
// ***
HRESULT GetArrayLength(IDispatch* pDisp, int* pLength)
{
         BSTR varName = L"length";
         VARIANT varValue;
         DISPPARAMS noArgs = {NULL, NULL, 0, 0};
         DISPID dispId;
         HRESULT hr = 0;

         hr = pDisp->GetIDsOfNames(IID_NULL, &varName, 1, LOCALE_USER_DEFAULT, &dispId);
         if (FAILED(hr))
                  return hr;
         hr = pDisp->Invoke(dispId, IID_NULL, LOCALE_SYSTEM_DEFAULT, DISPATCH_PROPERTYGET, &noArgs, &varValue, NULL, NULL);
         if (SUCCEEDED(hr))
         {
                  *pLength = varValue.intVal;
                  return hr;
         }
         else
         {
                  return hr;
         }
}
// ***
// 获取Javascript数组中指定位置的整数元素值
// ***
HRESULT GetArrayNumberOfIndex(IDispatch* pDisp, int index, int * pValue)
{
         CComVariant varName(index, VT_I4); // 数组下标
         DISPPARAMS noArgs = {NULL, NULL, 0, 0};
         DISPID dispId;
         VARIANT varValue;
         HRESULT hr = 0;       
         varName.ChangeType(VT_BSTR); // 将数组下标转为数字型，以进行GetIDsOfNames
         //
         // 获取通过下标访问数组的过程，将过程名保存在dispId中
         //
         hr = pDisp->GetIDsOfNames(IID_NULL, &varName.bstrVal, 1, LOCALE_USER_DEFAULT, &dispId);
         if (FAILED(hr))
                  return hr;
         //
         // 调用COM过程，访问指定下标数组元素，根据dispId 将元素值保存在varValue中
         //
         hr = pDisp->Invoke(dispId, IID_NULL, LOCALE_SYSTEM_DEFAULT, DISPATCH_PROPERTY GET , &noArgs, &varValue, NULL, NULL);
         if (SUCCEEDED(hr))
         {
                  *pValue = varValue.intVal;    // 将数组元素按int类型取出
                  return hr;
         }
         else
         {
                  return hr;
         }
}

5. JS中调用

function test_get_last()
{
       var array = new Array(0, 1, 2, 3); // 定义数组
       try {
              var obj = document.getElementByIdx_xx_x("obj");
              var lastElement = obj.GetLastElement(array); // 获取数组最后一个元素
              alert("lastElement: " + lastElement);
       } catch (e) {
              alert("JS ERROR: " + e.message);
       }
}

6. 测试执行

数组定义：{0,1,2,3}

最后元素：3

（五）IDispatch接口介绍

1. C程序调用时，调用者必须预先知道接口规范（如：参数类型、参数字节长度、参数顺序等）。由于不同语言这些规范有所不同，COM未解决不同语言之间调用，提供了IDispatch接口。

2. IDispatch要求其实例必须自我描述，即拿到一个对象后，可从对象中直接获取调用方式，而无须预先明确。

3. IDispatch中通过VT_TYPE来指定相关类型，如 VT_I4为4字节整型、VT_BSTR为unicode字符串，VT_DISPATCH表示是一个IDispatch对象

4. 给对象中每一属性或函数（Method）分配一个整型Id和一个字符串name，调用者可以通过name字符串确定如何调用。如：若name为"length"的属性，调用者就理解为长度。由于这里通常是根据name来理解相应属性，因此name描述应足够准确。如，以"length()"为名称的函数实现整数相加功能就是不恰当的。

5. 使用IDispatch对象时，首相调用 IDispatch::GetIDsOfNames()将属性、函数名称作为参数，获取对应的属性、函数id。

6. 再调用IDispatch::Invoke() 将id作为参数，实际调用功能。

7. 若为获取属性值，则 Invoke()调用时，传入 Dispatch_PropertyGet标志。

8. 若为设置属性值，则Invoke()调用时，传入 Dispatch_PropertyPut标志。并在 DispParams参数中指定修该属性改为何值。DispParams结构说明见后。

9. 若为调用函数，则 Invoke()调用时，传入 Dispatch_Method标志。若该Method需要参数，则通过IDispatch::Invoke()的DispParams参数指定。

10. DispParams结构使用举例：

DISPPARAMS dispparams;
         dispparams.rgdispidNamedArgs = &dispidOfNamedArgs;
         dispparams.cArgs = 1;
         dispparams.cNamedArgs = 1;
         dispparams.rgvarg = new VARIANTARG[1];
         dispparams.rgvarg[0].vt = VT_I4;
         dispparams.rgvarg[0].intVal = 123;

a. 上面代码是一个用于给Method传参的简单例子，先创建一个DispParams对象

b. cArgs指定Method中的参数个数。

c. cNamedArgs指定Method中已经命名的参数个数。（命名参数是对应无名参数的概念。有些语言可定义不定参数，此时IDispatch的描述中不会给参数分配名称，而是调用时以无名参数存在。如，JS中 Array对象的push()方法，可支持不定个数的参数）

d. rgvarg 为实际参数数组，每一元素表示一个参数，其中.vt表明此元素的数据类型，intVal项是一个C++联合结构，如vt == VT_I4时，应以intVal = xxx方式赋值；若 vt == VT_BSTR，则应以 bstrVal = xxx方式赋值

11. 举例：两个参数，都是无名称参数，第一个为整型，第二个为BSTR型

DISPPARAMS dispparams;
         dispparams.rgdispidNamedArgs = NULL;
         dispparams.cArgs = 2;
         dispparams.cNamedArgs = 0;
         dispparams.rgvarg = new VARIANTARG[2]; // 2个参数，分配2个空间
         dispparams.rgvarg[0].vt = VT_I4;  // 整型
         dispparams.rgvarg[0].intVal = 123;
         dispparams.rgvarg[1].vt = VT_BSTR; // 字符串型
         dispparams.rgvarg[1].bstrVal = L"abcd";

（六）修改输入数组内容

1. 第五节介绍了如何从JS向COM传递数组参数，以及如何在COM中获取参数。本节介绍如何在COM中修改JS传入的数组。

2. 修改JS数组值时，首先通过GetIDsOfNames获取指定序号元素的dispid；然后调用Invoke()，传入Dispatch_PropertyPut标志表明写操作，并在DispParams结构中指明此元素类型和元素值。

3. COM中C++定义

STDMETHODIMP CJsAtl::ArrayModiy(VARIANT vArray)
{
         SetArrayNumberOfIndex(vArray.pdispVal, 0, 123); // 修改数组第[0]个元素，值为
         return S_OK;
}
 
// ***
// 设置Javascript数组中指定位置的整数元素值
// ***
HRESULT SetArrayNumberOfIndex(IDispatch* pDisp, int index, int value)
{
         CComVariant varName(index, VT_I4);
         DISPID dispId;
         CComVariant varValue;
         HRESULT hr = 0;
         varName.ChangeType(VT_BSTR); // 将数组下标转为数字型，以进行GetIDsOfNames
         hr = pDisp->GetIDsOfNames
                  (IID_NULL, &varName.bstrVal, 1, LOCALE_USER_DEFAULT, &dispId);
         if (FAILED(hr)) 
                  return hr;
        
         DISPID dispidPut = DISPID_PROPERTYPUT; // put操作
         DISPPARAMS dispparams;
         dispparams.rgvarg = new VARIANTARG[1]; // 初始化rgvarg
         dispparams.rgvarg[0].vt = VT_I4; // 数据类型
         dispparams.rgvarg[0].intVal = value; // 更新值
         dispparams.cArgs = 1; // 参数数量
         dispparams.cNamedArgs = 1; // 参数名称
         dispparams.rgdispidNamedArgs = &dispidPut; // 操作DispId，表明本参数适用于put操作
 
         hr = pDisp->Invoke(dispId, IID_NULL, LOCALE_USER_DEFAULT, DISPATCH_PROPERTY PUT, &dispparams, NULL, NULL, NULL);
         return hr;
}
 

4. JS调用

function test_set_first()
{
       var array = new Array(0, 1, 2, 3);
       try {
              var obj = document.getElementByIdx_xx_x("obj");
              obj.ArrayModiy(array);
              alert("first element: " + array[0]);
       } catch (e) {
              alert("JS ERROR: " + e.message);
       }
}

5. 测试执行

原数组：{0, 1,2,3}

修改后：{123,1,2,3}