DispatchWrapper Class

Reference

Definition

Namespace:: System.Runtime.InteropServices

Assembly:: System.Runtime.InteropServices.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: DispatchWrapper.cs

Source:: DispatchWrapper.cs

Source:: DispatchWrapper.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

DispatchWrapper and support for marshalling to the VARIANT type may be unavailable in future releases.

Wraps objects the marshaler should marshal as a VT_DISPATCH.

public ref class DispatchWrapper sealed

[System.Obsolete("DispatchWrapper and support for marshalling to the VARIANT type may be unavailable in future releases.")]
public sealed class DispatchWrapper

[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public sealed class DispatchWrapper

public sealed class DispatchWrapper

[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public sealed class DispatchWrapper

[<System.Obsolete("DispatchWrapper and support for marshalling to the VARIANT type may be unavailable in future releases.")>]
type DispatchWrapper = class

[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
type DispatchWrapper = class

type DispatchWrapper = class

[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Serializable>]
type DispatchWrapper = class

Public NotInheritable Class DispatchWrapper

Inheritance: Object
DispatchWrapper

Attributes: ObsoleteAttribute SupportedOSPlatformAttribute ComVisibleAttribute SerializableAttribute

Remarks

Use to wrap objects the marshaler should marshal as a VT_DISPATCH. This wrapper will force objects to be marshaled out as VT_DISPATCH. If the object does not support IDispatch then an exception will be thrown.

void MyMethod(Object^ o);

void DoWrap()
{
    Object^ o = gcnew MyObject();
    MyMethod(o);                        // passes o as VT_UNKNOWN
    MyMethod(gcnew DispatchWrapper(o)); // passes o as VT_DISPATCH

    //...
}

void MyMethod(Object o);

public void DoWrap()
{
    Object o = new MyObject();
    MyMethod(o);                      // passes o as VT_UNKNOWN
    MyMethod(new DispatchWrapper(o)); // passes o as VT_DISPATCH

    //...
}

Sub MyMethod(o As Object)
    ' handle object ...
End Sub

Public Sub DoWrap()
    Dim o As Object = new MyObject()
    MyMethod(o)                      ' passes o as VT_UNKNOWN
    MyMethod(new DispatchWrapper(o)) ' passes o as VT_DISPATCH

    '...
End Sub

For more information on VT_DISPATCH, please see the existing documentation for VARENUM::VT_DISPATCH in the MSDN library.

Constructors

DispatchWrapper(Object)

Initializes a new instance of the DispatchWrapper class with the object being wrapped.

Properties

WrappedObject

Gets the object wrapped by the DispatchWrapper.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Jaa