Export (0) Print
Expand All
Expand Minimize

Marshal.SetComObjectData Method

Sets data referenced by the specified key in the specified COM object.

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

[SecurityPermissionAttribute(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public static bool SetComObjectData(
	Object obj,
	Object key,
	Object data
)

Parameters

obj
Type: System.Object

The COM object in which to store the data.

key
Type: System.Object

The key in the internal hash table of the COM object in which to store the data.

data
Type: System.Object

The data to set.

Return Value

Type: System.Boolean
true if the data was set successfully; otherwise, false.

ExceptionCondition
ArgumentNullException

obj is null.

-or-

key is null.

ArgumentException

obj is not a COM object.

All COM objects wrapped in a runtime callable wrapper have an associated hash table, to which SetComObjectData adds data. Marshal.GetComObjectData retrieves data from the hash table. You should never have to call either method from your code.

NoteNote:

This method uses SecurityAction.LinkDemand to prevent it from being called from untrusted code; only the immediate caller is required to have SecurityPermissionAttribute.UnmanagedCode permission. If your code can be called from partially trusted code, do not pass user input to Marshal class methods without validation. For important limitations on using the LinkDemand member, see Demand vs. LinkDemand.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

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

Community Additions

ADD
Show:
© 2014 Microsoft