如何通过IDispatch将SAFEARRAY传递给COM对象?

时间:2012-08-15 21:44:08

标签: winapi com variant safearray

我正在尝试调用COM对象的方法,其中 记录的 参数之一是“字节数组”。实际声明取决于您正在查看的每种语言文档:

    C#语言中的
  • byte[] TransformFinalBlock(
        byte[] inputBuffer,
        int inputOffset,
        int inputCount
    )
    
  • C ++ 语言;

    array<unsigned char>^ TransformFinalBlock(
        array<unsigned char>^ inputBuffer, 
        int inputOffset, 
        int inputCount
    )
    
  • VB 语言中的
  • Function TransformFinalBlock ( _
        inputBuffer As Byte(), _
        inputOffset As Integer, _
        inputCount As Integer _
    ) As Byte()
    
  • F#语言中
  • abstract TransformFinalBlock : 
            inputBuffer:byte[] * 
            inputOffset:int * 
            inputCount:int -> byte[] 
    

我也可以使用 COM 访问我正在使用的对象。该对象提供了一个早期绑定接口ICryptoTransform,它将该方法声明为使用SAFEARRAY

来自类型库

  • 使用 IDL 语法

    [
      odl,
      uuid(8ABAD867-F515-3CF6-BB62-5F0C88B3BB11),
      version(1.0),
      dual,
      oleautomation,
      custom(0F21F359-AB84-41E8-9A78-36D110E6D2F9, "System.Security.Cryptography.ICryptoTransform")    
    ]
    interface ICryptoTransform : IDispatch {
       ...
       [id(0x60020005)]
       HRESULT TransformFinalBlock(
                    [in] SAFEARRAY(unsigned char) inputBuffer, 
                    [in] long inputOffset, 
                    [in] long inputCount, 
                    [out, retval] SAFEARRAY(unsigned char)* pRetVal);
    };
    
  • 使用对象Pascal 语法:

    ICryptoTransform = interface(IDispatch)
         ['{8ABAD867-F515-3CF6-BB62-5F0C88B3BB11}']
         ...
         function TransformFinalBlock(inputBuffer: PSafeArray; inputOffset: Integer; inputCount: Integer): PSafeArray; safecall;
    end;
    

这意味着当使用早期绑定时,您必须传递方法a SAFEARRAY。我使用的语言支持SafeArray API,我可以轻松地执行调用:

var
   inputBuffer: PSafeArray;
   xform: ICryptoTransform;
   ...
begin
   ...

   xform.TransformFinalBlock(inputBuffer, ...);
   ...
end;

以下是类似java语言的相同代码:

PSafeArray inputBuffer;
ICryptoTransform xform;

...

xform.TransformFinalBlock(inputBuffer, ...);

一切正常很好;但这不是我的问题。

  

注意:我正在尝试将驱动器归结为与语言无关的问题,因为 COM是一种与语言无关的技术 。但在某些时候,我们必须实际使用我们将在。Some people confuse a language with a technology中演示代码的语言。如果我知道Knuth的发明语言,我会用它。

但是晚期约束IDispatch呢?

现在我们知道可以SAFEARRAY传递给COM对象(当使用 早期绑定 时),我需要解决使用 后期绑定 传递数组的问题。

  

注意:在ICryptoTransform之外的情况下,如何通过IDispatch将SAFEARRAY传递给COM对象的问题非常有用。

     

某些语言提供了自动机制,可以在运行时通过IDispatch接口调用方法(即后期绑定)。事实上,IDispatch后期绑定是为VBScript发明的:

Dim xform = CreateObject("System.Security.Cryptography.SHA256Managed");
Dim buffer;
o.TransformFinalBlock(buffer, 0, 8);

在.NET 4.0中添加了后期绑定编译器自动魔术:

dynamic xform = Activator.CreateInstance(Type.GetTypeFromProgID("System.Security.Cryptography.SHA256Managed", true));
xform.TransformFinalBlock(buffer, 0, 8);

后期绑定编译器魔法也存在于Delphi中:

xform: OleVariant;
buffer: OleVariant;
xform.TransformFinalBlock(buffer, 0, 8);

发生使用Dephi,此调用失败。

但它并不是真正的编译器魔法

VBScript,C#dynamic和Delphi正在做的事情并不神奇。他们只是打电话给IDispatch.Invoke

IDispatch = interface(IUnknown)
   ['{00020400-0000-0000-C000-000000000046}']
   function Invoke(DispID: Integer; const IID: TGUID; LocaleID: Integer;
         Flags: Word; var Params; VarResult, ExcepInfo, ArgErr: Pointer): HResult; stdcall;
end;

混乱是设置这些参数:

xform.Invoke(
      1610743820,      //DispID
      IID_NULL,        //riid (reserved for future use, must be IID_NULL)
      0,               //locale id (lcid)
      DISPATCH_METHOD, //flags
      dispParams,      //Pointer to a DISPPARAMS structure
      null,            //Pointer to the location where the result is to be stored, or NULL if the caller expects no result
      exceptInfo,      //Pointer to a structure that contains exception information
      null);           //This argument can be set to null. 

真正的技巧是dispParams结构,其中包含参数。

参数将是变体

通过DISPPARAMS传递的参数都是变体:

typedef struct tagDISPPARAMS {
  VARIANTARG *rgvarg;
  DISPID     *rgdispidNamedArgs;
  UINT       cArgs;
  UINT       cNamedArgs;
} DISPPARAMS;

所以无论发生什么事,我的“字节数组”都将成为一种变体。

Win32中的VARIANT只是一个包含以下内容的联合:

  • VARTYPE vt:联合中的数据类型。
  • 适当的工会成员,例如:

    BYTE        bVal;
    IDispatch  *pdispVal;
    SAFEARRAY  *parray;
    BYTE       *pbVal;
    IDispatch  *ppdispVal;
    SAFEARRAY  *pparray;
    VARIANT    *pvarVal;
    PVOID       byref;
    CHAR        cVal;
    

到目前为止,我一直在传递类型的变体:

vt = VT_ARRAY | VT_UI1

MSDN记录了当您想要将 parray 联合使用VT_ARRAY | *时必须执行的操作:

  

VT_ARRAY | <anything>

     

说明:传递了一组数据类型。 VT_EMPTY和VT_NULL是与VT_ARRAY组合的无效类型。 pbyrefVal 中的指针指向数组描述符,该描述符描述数组的维度,大小和内存位置。

这意味着使用 parray 成员:

    SAFEARRAY  *parray;

您需要将parray成员设置为指向SAFEARRAY结构的指针:

typedef struct tagSAFEARRAY {
  USHORT         cDims;
  USHORT         fFeatures;
  ULONG          cbElements;
  ULONG          cLocks;
  PVOID          pvData;
  SAFEARRAYBOUND rgsabound[1];
} SAFEARRAY, *LPSAFEARRAY;

在我的情况下,我的 字节数组 实际上是SAFEARRAY,然后存储在变体中:

VARIANT *inputBuffer;
SAFEARRAY *safeArray;

//Setup our SAFEARRAY of data
safeArray.cDims = 1;
safeArray.fFeatures = FADF_HAVEVARTYPE;
safeArray.cbElements = 1;
safeArray.cbLocks = 0;
safeArray.pvData = pMyData;
safeArray.rgsabound[0].ElementCount = 1;
safeArray.rgsabound[0].LowBound = 0;

//Wrap the safearray in a variant
inputBuffer.vt = VT_ARRAY | VT_UI1; //$2011
vt.parray = safeArray;
  

注意:当然,我自己并没有疯狂创造这个安全阵列;我正在使用SafeArrayCreate api函数。我只是在证明这一切都是可知的,而不是魔术。

换句话说,我传递一个字节数组

换句话说,我 am 传递包含在变体中的字节数组,因为所有调用都是:

dispatch.Invoke(...);
必须是。除了后期绑定调用引发错误:

The parameter is incorrect.

那么我可能做错了什么?

如何将字节数组传递给后期绑定 IDispatch来电?

我的问题

如何通过IDispatch将SAFEARRAY传递给COM对象?

1 个答案:

答案 0 :(得分:2)

这应该会给你一些见解:

在来电方面,C#代码:

Foo foo = new Foo();
byte[] input = new byte[] { 1, 2, 3, 4 };
byte[] output = foo.Bar(input);
byte[] referenceOutput = new byte[] { 4, 3, 2, 1 };
Debug.Assert(Enumerable.SequenceEqual(output, referenceOutput));

Foo.Bar IDL:

interface IFoo : IDispatch
{
    [id(1)] HRESULT Bar([in] VARIANT vInput, [out, retval] VARIANT* pvOutput);
};

使用安全数组的C ++(ATL)服务器实现:

// IFoo
    STDMETHOD(Bar)(VARIANT vInput, VARIANT* pvOutput) throw()
    {
        _ATLTRY
        {
            ATLENSURE_THROW(vInput.vt == (VT_ARRAY | VT_UI1), E_INVALIDARG);
            CComSafeArray<BYTE> pInputArray(vInput.parray);
            ATLASSERT(pInputArray.GetDimensions() == 1);
            const ULONG nCount = pInputArray.GetCount();
            CComSafeArray<BYTE> pOutputArray;
            ATLENSURE_SUCCEEDED(pOutputArray.Create(nCount));
            for(ULONG nIndex = 0; nIndex < nCount; nIndex++)
                pOutputArray[(INT) nIndex] = pInputArray[(INT) ((nCount - 1) - nIndex)];
            ATLASSERT(pvOutput);
            VariantInit(pvOutput);
            CComVariant vOutput(pOutputArray.Detach());
            ATLVERIFY(SUCCEEDED(vOutput.Detach(pvOutput)));
        }
        _ATLCATCH(Exception)
        {
            return Exception;
        }
        return S_OK;
    }

来源:TracSubversion - 提防Visual Studio 2012。