Skip to content

Commit fc02260

Browse files
AaronRobinsonMSFTmairaw
authored andcommitted
Add remarks (#2779)
Provide remarks on the `GetFunctionPointer()` function.
1 parent 6153a91 commit fc02260

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

xml/System/RuntimeMethodHandle.xml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,12 @@
200200
<Docs>
201201
<summary>Obtains a pointer to the method represented by this instance.</summary>
202202
<returns>A pointer to the method represented by this instance.</returns>
203-
<remarks>To be added.</remarks>
203+
<remarks>
204+
<format type="text/markdown"><![CDATA[
205+
## Remarks
206+
The returned <xref:System.IntPtr> is meant for internal runtime usage and should not be used to call the function from native code. Use <xref:System.Runtime.InteropServices.Marshal.GetFunctionPointerForDelegate%2A?displayProperty=nameWithType> in order to get a function pointer that can be passed to native code.
207+
]]></format>
208+
</remarks>
204209
<exception cref="T:System.Security.SecurityException">The caller does not have the necessary permission to perform this operation.</exception>
205210
<permission cref="T:System.Security.SecurityCriticalAttribute">Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.</permission>
206211
</Docs>
@@ -442,4 +447,4 @@
442447
</Docs>
443448
</Member>
444449
</Members>
445-
</Type>
450+
</Type>

0 commit comments

Comments
 (0)