Marshaling padrão para objetos

Os parâmetros e os campos tipados como System.Object podem ser expostos para um código não gerenciado como um dos seguintes tipos:

• Uma variante quando o objeto é um parâmetro.

• Uma interface quando o objeto é um campo de estrutura.

Somente a interoperabilidade COM dá suporte ao marshaling de tipos de objeto. O comportamento padrão é realizar marshaling de objetos para variantes COM. Essas regras se aplicam apenas ao tipo Object e não se aplicam a objetos fortemente tipados que derivam da classe Object.

Opções de marshaling

A tabela a seguir mostra as opções de marshalling para o Object tipo de dados. O atributo MarshalAsAttribute fornece vários valores de enumeração UnmanagedType para realizar marshaling de objetos.

O exemplo a seguir mostra a definição de interface gerenciada para MarshalObject.

Interface MarshalObject
   Sub SetVariant(o As Object)
   Sub SetVariantRef(ByRef o As Object)
   Function GetVariant() As Object

   Sub SetIDispatch( <MarshalAs(UnmanagedType.IDispatch)> o As Object)
   Sub SetIDispatchRef(ByRef <MarshalAs(UnmanagedType.IDispatch)> o _
      As Object)
   Function GetIDispatch() As <MarshalAs(UnmanagedType.IDispatch)> Object
   Sub SetIUnknown( <MarshalAs(UnmanagedType.IUnknown)> o As Object)
   Sub SetIUnknownRef(ByRef <MarshalAs(UnmanagedType.IUnknown)> o _
      As Object)
   Function GetIUnknown() As <MarshalAs(UnmanagedType.IUnknown)> Object
End Interface

interface MarshalObject {
   void SetVariant(Object o);
   void SetVariantRef(ref Object o);
   Object GetVariant();

   void SetIDispatch ([MarshalAs(UnmanagedType.IDispatch)]Object o);
   void SetIDispatchRef([MarshalAs(UnmanagedType.IDispatch)]ref Object o);
   [MarshalAs(UnmanagedType.IDispatch)] Object GetIDispatch();
   void SetIUnknown ([MarshalAs(UnmanagedType.IUnknown)]Object o);
   void SetIUnknownRef([MarshalAs(UnmanagedType.IUnknown)]ref Object o);
   [MarshalAs(UnmanagedType.IUnknown)] Object GetIUnknown();
}

O código a seguir exporta a interface MarshalObject para uma biblioteca de tipos.

interface MarshalObject {
   HRESULT SetVariant([in] VARIANT o);
   HRESULT SetVariantRef([in,out] VARIANT *o);
   HRESULT GetVariant([out,retval] VARIANT *o)
   HRESULT SetIDispatch([in] IDispatch *o);
   HRESULT SetIDispatchRef([in,out] IDispatch **o);
   HRESULT GetIDispatch([out,retval] IDispatch **o)
   HRESULT SetIUnknown([in] IUnknown *o);
   HRESULT SetIUnknownRef([in,out] IUnknown **o);
   HRESULT GetIUnknown([out,retval] IUnknown **o)
}

O exemplo a seguir mostra um tipo de valor formatado.

Public Structure ObjectHolder
   Dim o1 As Object
   <MarshalAs(UnmanagedType.IDispatch)> Public o2 As Object
End Structure

public struct ObjectHolder {
   Object o1;
   [MarshalAs(UnmanagedType.IDispatch)]public Object o2;
}

O código a seguir exporta o tipo formatado para uma biblioteca de tipos.

struct ObjectHolder {
   VARIANT o1;
   IDispatch *o2;
}

Realizando marshaling de objeto para interface

Quando um objeto é exposto ao COM como uma interface, essa interface é a interface de classe para o tipo Object gerenciado (a _Object interface). Essa interface é digitada como um IDispatch (UnmanagedType) ou um IUnknown (UnmanagedType.IUnknown) na biblioteca de tipos resultante. Os clientes COM podem invocar dinamicamente os membros da classe gerenciada ou quaisquer membros implementados por suas classes derivadas por meio da _Object interface. O cliente também pode chamar QueryInterface para obter qualquer outra interface explicitamente implementada pelo tipo gerenciado.

Realizando marshaling de objeto para variante

Quando um objeto é empacotado em uma variante, o tipo de variante interna é determinado em runtime, com base nas seguintes regras:

• Se a referência de objeto for nula (Nothing no Visual Basic), o objeto terá o marshaling realizado como uma variante do tipo VT_EMPTY.

• Se o objeto for uma instância de qualquer tipo listado na tabela a seguir, o tipo de variante resultante será determinado pelas regras internas do marshaler e mostrado na tabela.

• Outros objetos que precisam controlar explicitamente o comportamento de marshaling podem implementar a interface IConvertible. Nesse caso, o tipo de variante é determinado pelo código do tipo retornado do método IConvertible.GetTypeCode. Caso contrário, o objeto terá o marshaling realizado como uma variante do tipo VT_UNKNOWN.

Realizando marshaling de tipos do sistema para variante

A tabela a seguir mostra os tipos de objeto gerenciados e seus tipos de variante COM correspondentes. Esses tipos são convertidos somente quando a assinatura do método que está sendo chamado é do tipo System.Object.

Usando a interface MarshalObject definida no exemplo anterior, o exemplo de código a seguir demonstra como passar vários tipos de variantes para um servidor COM.

Dim mo As New MarshalObject()
mo.SetVariant(Nothing)         ' Marshal as variant of type VT_EMPTY.
mo.SetVariant(System.DBNull.Value) ' Marshal as variant of type VT_NULL.
mo.SetVariant(CInt(27))        ' Marshal as variant of type VT_I2.
mo.SetVariant(CLng(27))        ' Marshal as variant of type VT_I4.
mo.SetVariant(CSng(27.0))      ' Marshal as variant of type VT_R4.
mo.SetVariant(CDbl(27.0))      ' Marshal as variant of type VT_R8.

MarshalObject mo = new MarshalObject();
mo.SetVariant(null);            // Marshal as variant of type VT_EMPTY.
mo.SetVariant(System.DBNull.Value); // Marshal as variant of type VT_NULL.
mo.SetVariant((int)27);          // Marshal as variant of type VT_I2.
mo.SetVariant((long)27);          // Marshal as variant of type VT_I4.
mo.SetVariant((single)27.0);   // Marshal as variant of type VT_R4.
mo.SetVariant((double)27.0);   // Marshal as variant of type VT_R8.

Tipos COM que não têm tipos gerenciados correspondentes podem ter o marshaling realizado usando classes wrapper como ErrorWrapper, DispatchWrapper, UnknownWrapper e CurrencyWrapper. O exemplo de código a seguir demonstra como usar esses wrappers para passar vários tipos de variantes para um servidor COM.

Imports System.Runtime.InteropServices
' Pass inew as a variant of type VT_UNKNOWN interface.
mo.SetVariant(New UnknownWrapper(inew))
' Pass inew as a variant of type VT_DISPATCH interface.
mo.SetVariant(New DispatchWrapper(inew))
' Pass a value as a variant of type VT_ERROR interface.
mo.SetVariant(New ErrorWrapper(&H80054002))
' Pass a value as a variant of type VT_CURRENCY interface.
mo.SetVariant(New CurrencyWrapper(New Decimal(5.25)))

using System.Runtime.InteropServices;
// Pass inew as a variant of type VT_UNKNOWN interface.
mo.SetVariant(new UnknownWrapper(inew));
// Pass inew as a variant of type VT_DISPATCH interface.
mo.SetVariant(new DispatchWrapper(inew));
// Pass a value as a variant of type VT_ERROR interface.
mo.SetVariant(new ErrorWrapper(0x80054002));
// Pass a value as a variant of type VT_CURRENCY interface.
mo.SetVariant(new CurrencyWrapper(new Decimal(5.25)));

As classes wrapper são definidas no namespace System.Runtime.InteropServices.

Realizando marshaling da interface IConvertible para variante

Outros tipos além daqueles listados na seção anterior podem controlar seu marshaling com a implementação da interface IConvertible. Se o objeto implementar a interface IConvertible, o tipo de variante COM será determinado em tempo de execução pelo valor da enumeração TypeCode retornada pelo método IConvertible.GetTypeCode.

A tabela a seguir mostra os valores possíveis para a TypeCode enumeração e o tipo de variante COM correspondente para cada valor.

O valor da variante COM é determinado chamando a interface IConvertible.ToType, onde To é a rotina de conversão que corresponde ao tipo retornado por IConvertible.GetTypeCode. Por exemplo, um objeto que retorna TypeCode.Double de IConvertible.GetTypeCode tem o marshaling realizado como uma variante COM do tipo VT_R8. Você pode obter o valor da variante (armazenada no dblVal campo da variante COM) lançando para a IConvertible interface e chamando o ToDouble método.

Realizando marshaling de variante para objeto

Ao realizar marshaling de uma variante para um objeto, o tipo e, às vezes, o valor, da variante com marshaling determina o tipo de objeto produzido. A tabela a seguir identifica cada tipo de variante e o tipo de objeto correspondente criado pelo marshaler quando uma variante é passada do COM para o .NET Framework.

Os tipos de variante passados do COM para o código gerenciado e, em seguida, novamente para o COM podem não manter o mesmo tipo de variante durante a chamada. Considere o que acontece quando uma variante do tipo VT_DISPATCH é passada de COM para o .NET Framework. Durante o marshaling, a variante é convertida em um System.Object. Se ele Object for passado de volta para COM, ele será empacotado de volta para uma variante do tipo VT_UNKNOWN. Não há nenhuma garantia de que a variante produzida quando um objeto tem o marshaling realizado de um código gerenciado para o COM terá o mesmo tipo de variante usado inicialmente para produzir o objeto.

Realizando marshaling de variantes de ByRef

Embora as variantes em si possam ser passadas por valor ou por referência, o VT_BYREF sinalizador também pode ser usado com qualquer tipo de variante para indicar que o conteúdo da variante está sendo passado por referência em vez de por valor. A diferença entre o marshalling de variantes por referência e o marshalling de uma variante com o sinalizador VT_BYREF ativado pode ser confusa. A seguinte ilustração esclarece as diferenças:

Variantes passadas por valor e por referência

Comportamento padrão de marshaling de objetos e variantes por valor

• Ao passar objetos do código gerenciado para o COM, o conteúdo do objeto é copiado para uma nova variante criada pelo marshaler, usando as regras definidas em Realizando marshaling de objeto para variante. As alterações feitas na variante no lado não gerenciado não são propagadas novamente para o objeto original após o retorno da chamada.

• Ao passar variantes do COM para o código gerenciado, o conteúdo da variante é copiado para um objeto recém-criado, usando as regras definidas em Realizando marshaling de variante para objeto. As alterações feitas no objeto no lado gerenciado não são propagadas novamente para a variante original após o retorno da chamada.

Comportamento padrão de marshaling de objetos e variantes por referência

Para propagar as alterações novamente para o chamador, os parâmetros devem ser passados por referência. Por exemplo, você pode usar a ref palavra-chave em C# (ou ByRef no código gerenciado do Visual Basic) para passar parâmetros por referência. No COM, os parâmetros de referência são passados usando um ponteiro, como uma variante *.

• Ao passar um objeto para o COM por referência, o marshaler cria uma nova variante e copia o conteúdo da referência de objeto para a variante antes que a chamada seja feita. A variante é passada para a função não gerenciada, na qual o usuário é livre para alterar o conteúdo da variante. Após o retorno da chamada, todas as alterações feitas na variante no lado não gerenciado são propagadas novamente para o objeto original. Se o tipo da variante for diferente do tipo da variante passada para a chamada, as alterações serão propagadas novamente para um objeto de um tipo diferente. Ou seja, o tipo do objeto passado para a chamada pode ser diferente do tipo do objeto retornado da chamada.

• Ao passar uma variante para um código gerenciado por referência, o marshaler cria um novo objeto e copia o conteúdo da variante para o objeto antes de fazer a chamada. Uma referência ao objeto é passada para a função gerenciada, em que o usuário é livre para alterar o objeto. Após o retorno da chamada, todas as alterações feitas no objeto referenciado são propagadas novamente para a variante original. Se o tipo do objeto for diferente do tipo do objeto passado para a chamada, o tipo da variante original será alterado e o valor será propagado novamente para a variante. Novamente, o tipo da variante passado para a chamada pode ser diferente do tipo da variante retornado da chamada.

Comportamento padrão de marshaling de uma variante com o sinalizador VT_BYREF definido

• Uma variante que está sendo passada para o código gerenciado por valor pode ter o VT_BYREF sinalizador definido para indicar que a variante contém uma referência em vez de um valor. Nesse caso, a variante ainda tem o marshaling realizado para um objeto porque a variante está sendo passada por valor. O marshaler desreferencia automaticamente o conteúdo da variante e o copia para um objeto recém-criado antes de fazer a chamada. Em seguida, o objeto é passado para a função gerenciada; no entanto, após o retorno da chamada, o objeto não é propagado novamente para a variante original. As alterações feitas no objeto gerenciado são perdidas.

  Cuidado

  Não há como alterar o valor de uma variante passada por valor, mesmo que a variante tenha o VT_BYREF conjunto de sinalizadores.

• Uma variante que está sendo passada para o código gerenciado por referência também pode ter o VT_BYREF sinalizador definido para indicar que a variante contém outra referência. Se isso acontecer, a variante será enviada para um ref objeto porque a variante está sendo passada por referência. O marshaler desreferencia automaticamente o conteúdo da variante e o copia para um objeto recém-criado antes de fazer a chamada. Após o retorno da chamada, o valor do objeto é propagado novamente para a referência dentro da variante original somente se o objeto é do mesmo tipo do objeto passado. Ou seja, a propagação não altera o tipo de uma variante com o VT_BYREF conjunto de sinalizadores. Se o tipo do objeto for alterado durante a chamada, ocorrerá uma InvalidCastException após o retorno da chamada.

A tabela a seguir resume as regras de propagação para variantes e objetos.

Confira também

• Comportamento de marshaling padrão
• Tipos blittable e não blittable
• Atributos direcionais
• Copiando e fixando