最近在一个项目中需要开发一个ocx插件,在开发过程中发现了一些问题,所以在此记录一下。
我想讨论的主要是函数的参数问题,我分别使用c++,JavaScript,C#对ocx插件做了测试,发现不同的参数类型在这几种语言中表现的差异很大。
(1)首先ocx我是使用C++开发的,所以在同样使用c++语言开发的程序中调用,所有的参数类型都没有问题。
(2)所有指针类型如:long *,float *,BSTR*作为参数时,在JavaScript中调用都会失败,可能在JavaScript中就不能支持这种指针传参方式。
在C#中是能够正常调用的。指针类型在C#中会被转换为ref type类型,指明这个参数的值是能够被函数内部所修改的。像以下的调用方式是成功的。
ActiveX中的函数原型:
LONG CSimpleActiveXCtrl::GetData(LONG v1, LONG* v2)
{
AFX_MANAGE_STATE(AfxGetStaticModuleState());
*v2 = 10;
return v1;
}
C#自动生成的函数定义:
public virtual int GetData(int v1, ref int v2);
C#中调用:
int a=12, b=0;
int c=axSimpleActiveX1.GetData(a,ref b);
虽然在C#中能够正常调用,但是在JavaScript没办法调用,说明这种类型不是通用的,如果你想你开发的控件是通用的,应该禁止使用指针类型。
(3)数组参数
如果你需要传递一个数组,参数类型可以定义为Variant,但是对于数组的处理,在C#中和JavaScript中又是不一样的。JavaScript传入的数组,其vt类型是VT_DISPATCH,
而C#传入的数组不是VT_DISPATCH类型,所以取值或赋值的方式又不同了。如果你只需要取得数组的值,那么只需要定义为Variant类型就可以了,如果你需要修改数组
的值,用于C#需要定义为Variant*类型,而对于JavaScript只需要定义为Variant类型就可以。所以说在不同语言里面的表现很不一样。很显然Variant类型也没办法做到通用。
ActiveX中的定义:
1)取数组长度:
long CSimpleActiveXCtrl::GetArrayLength(VARIANT &v1)
{
if (v1.vt == VT_DISPATCH) //JS数组
{
IDispatch* pDisp = v1.pdispVal;
int ret;
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))
{
ret = varValue.intVal;
return ret;
}
else
{
return 0;
}
}
else //C#数组
{
long Low(0), High(0);
SAFEARRAY* pArr1 = v1.parray;
SafeArrayGetLBound(pArr1, 1, &Low);
SafeArrayGetUBound(pArr1, 1, &High);
long len = High - Low + 1;
return len;
}
}
2)数组取值
bool CSimpleActiveXCtrl::GetArrayDataI(VARIANT &v1, int index, int &data)
{
if (v1.vt == VT_DISPATCH) //JS数组
{
IDispatch* pDisp = v1.pdispVal;
ATL::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 false;
//
// 调用COM过程,访问指定下标数组元素,根据dispId 将元素值保存在varValue中
//
hr = pDisp->Invoke(dispId, IID_NULL, LOCALE_SYSTEM_DEFAULT, DISPATCH_PROPERTYGET, &noArgs, &varValue, NULL, NULL);
if (SUCCEEDED(hr))
{
data = varValue.intVal; // 将数组元素按int类型取出
return true;
}
else
{
return false;
}
}
else //C#数组
{
SAFEARRAY* pArr = v1.parray;
int *pValue;
SafeArrayAccessData(pArr, (void**)&pValue);
data = pValue[index];
SafeArrayUnaccessData(pArr);
return true;
}
}
3)数组赋值
bool CSimpleActiveXCtrl::SetArrayDataI(VARIANT &v1, int index, int data)
{
if (v1.vt == VT_DISPATCH) //JS数组
{
IDispatch* pDisp = v1.pdispVal;
ATL::CComVariant varName(index, VT_I4);
DISPID dispId;
ATL::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 false;
DISPID dispidPut = DISPID_PROPERTYPUT; // put操作
DISPPARAMS dispparams;
dispparams.rgvarg = new VARIANTARG[1]; // 初始化rgvarg
dispparams.rgvarg[0].vt = VT_I4; // 数据类型
dispparams.rgvarg[0].intVal = data; // 更新值
dispparams.cArgs = 1; // 参数数量
dispparams.cNamedArgs = 1; // 参数名称
dispparams.rgdispidNamedArgs = &dispidPut; // 操作DispId,表明本参数适用于put操作
hr = pDisp->Invoke(dispId, IID_NULL, LOCALE_USER_DEFAULT, DISPATCH_PROPERTYPUT, &dispparams, NULL, NULL, NULL);
return true;
}
else //C#数组
{
long Low(0), High(0);
SAFEARRAY* pArr = v1.parray;
int *pValue;
SafeArrayAccessData(pArr, (void**)&pValue);
pValue[index]=data;
SafeArrayUnaccessData(pArr);
return true;
}
}
4)JS数组拷贝
LONG CSimpleActiveXCtrl::CopyArrayData(VARIANT &v1, VARIANT &v2)
{
AFX_MANAGE_STATE(AfxGetStaticModuleState());
long len = GetArrayLength(v1);
for (int i = 0; i < len; i++)
{
int value;
GetArrayDataI(v1, i, value);
SetArrayDataI(v2, i, value);
}
return 0;
}
5)C#数组拷贝
LONG CSimpleActiveXCtrl::CopyArray_CS(VARIANT &v1, VARIANT* v2)
{
AFX_MANAGE_STATE(AfxGetStaticModuleState());
// TODO: 在此添加调度处理程序代码
long len = GetArrayLength(v1);
for (int i = 0; i < len; i++)
{
int value;
GetArrayDataI(v1, i, value);
SetArrayDataI(*v2, i, value);
}
return 0;
}
JS中的调用例子:
function CopyArrayClick()
{
var arr1 = new Array();
var arr2 = new Array();
for (var i = 0; i < 10; i++)
{
arr1[i] = i;
arr2[i] = 0;
}
var c = SimpleActiveX.CopyArrayData(arr1, arr2);
var tmp = "";
for (var j = 0; j < 10; j++)
tmp += arr2[j];
document.getElementById("ResultDisplay").value = "arr2:" + tmp;
}
C#中的调用例子:
private void button1_Click(object sender, EventArgs e)
{
int[] arr1 = new int[10];
int[] arr2 = new int[10];
for (int i = 0; i < 10; i++)
arr1[i] = i;
object var = new System.Runtime.InteropServices.VariantWrapper(arr2);
axSimpleActiveX1.CopyArray_CS(arr1, ref var);
int[] arr3 = var as int[];
string te="";
for (int i = 0; i < 10; i++)
te += string.Format("{0} ", arr3[i]);
textBox1.AppendText(te);
}
从上面的测试结果来看,对于ocx控件开发中,参数的选择我有以下的建议:
1.避免使用指针类型;
2.如果需要输出参数应该以函数返回值的方式返回,如果有多个参数要返回可以分成多个函数来实现或者通过属性来返回;
3.个人认为可以使用BSTR来替代数组,不管作为参数或者返回值都更容易实现,在不同语言中对字符串的操作都是类似的。