This topic has not yet been rated - Rate this topic

DispatchWrapper Class

.NET Framework 4.5

Other Versions

Wraps objects the marshaler should marshal as a VT_DISPATCH.

Inheritance Hierarchy

System.Object
System.Runtime.InteropServices.DispatchWrapper

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (in mscorlib.dll)

Syntax

C++

[SerializableAttribute]
[ComVisibleAttribute(true)]
public sealed class DispatchWrapper

The DispatchWrapper type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	WrappedObject	Gets the object wrapped by the DispatchWrapper.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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.

C++

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 

    //...
}

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

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.Runtime.InteropServices Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)