SetComObjectData Method
TOC
Collapse the table of content
Expand the table of content

Marshal.SetComObjectData Method

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

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

public static bool SetComObjectData (
	Object obj,
	Object key,
	Object data
)
public static boolean SetComObjectData (
	Object obj, 
	Object key, 
	Object data
)
public static function SetComObjectData (
	obj : Object, 
	key : Object, 
	data : Object
) : boolean
Not applicable.

Parameters

obj

The COM object in which to store the data.

key

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

data

The data to set.

Return Value

true if the data was set successfully; otherwise, false.

Exception typeCondition

ArgumentNullException

obj is a null reference (Nothing in Visual Basic).

-or-

key is a null reference (Nothing in Visual Basic).

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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2016 Microsoft