Marshal.SetComObjectData(Object, Object, Object) Method

Reference

Definition

Namespace:: System.Runtime.InteropServices

Assembly:: System.Runtime.InteropServices.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: Marshal.NoCom.cs

Source:: Marshal.NoCom.cs

Source:: Marshal.NoCom.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.

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

public:
 static bool SetComObjectData(System::Object ^ obj, System::Object ^ key, System::Object ^ data);

[System.Runtime.Versioning.SupportedOSPlatform("windows")]
public static bool SetComObjectData (object obj, object key, object? data);

public static bool SetComObjectData (object obj, object key, object data);

public static bool SetComObjectData (object obj, object key, object? data);

[System.Security.SecurityCritical]
public static bool SetComObjectData (object obj, object key, object data);

[<System.Runtime.Versioning.SupportedOSPlatform("windows")>]
static member SetComObjectData : obj * obj * obj -> bool

static member SetComObjectData : obj * obj * obj -> bool

[<System.Security.SecurityCritical>]
static member SetComObjectData : obj * obj * obj -> bool

Public Shared Function SetComObjectData (obj As Object, key As Object, data As Object) As Boolean

Parameters

obj: Object

The COM object in which to store the data.

key: Object

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

data: Object

The data to set.

Returns

Boolean

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

Attributes: SupportedOSPlatformAttribute SecurityCriticalAttribute

Exceptions

ArgumentNullException

obj is null.

-or-

key is null.

ArgumentException

obj is not a COM object.

-or-

obj is a Windows Runtime object.

Remarks

All COM objects wrapped in a Runtime Callable Wrapper (RCW) 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.

Applies to