Skip to content

Commit dee988e

Browse files
committed
Add XML remarks for 'ManagedObjectWrapper'
1 parent 3c53ea2 commit dee988e

File tree

1 file changed

+11
-0
lines changed
  • src/libraries/System.Runtime.InteropServices/src/System/Runtime/InteropServices/Marshalling

1 file changed

+11
-0
lines changed

src/libraries/System.Runtime.InteropServices/src/System/Runtime/InteropServices/Marshalling/ComInterfaceOptions.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@ public enum ComInterfaceOptions
2323
/// <summary>
2424
/// Generate a wrapper for managed objects to enable exposing them through the COM interface.
2525
/// </summary>
26+
/// <remarks>
27+
/// <para>
28+
/// When this flag is the only one specified on a given COM interface, no implementation methods will be generated
29+
/// to support <see cref="System.Runtime.InteropServices.IDynamicInterfaceCastable"/> casts. In such a scenario,
30+
/// attempting to cast to that interface type will still succeed, but any calls to interface methods will fail.
31+
/// </para>
32+
/// <para>
33+
/// Using only this flag is purely a binary size optimization. If calling methods via this interface on native
34+
/// object is required, the <see cref="ComObjectWrapper"/> flag should also be used instead.
35+
/// </para>
36+
/// </remarks>
2637
ManagedObjectWrapper = 0x1,
2738
/// <summary>
2839
/// Generate a wrapper for COM objects to enable exposing them through the managed interface.

0 commit comments

Comments
 (0)