Skip to content

Commit d3af8a5

Browse files
jkotasRon Petrusha
andcommitted
Update GCHandle.xml (#3169)
* Update GCHandle.xml Incorporate feedback from https://github.com/dotnet/coreclr/issues/26658#issuecomment-530487407 * Update xml/System.Runtime.InteropServices/GCHandle.xml Co-Authored-By: Ron Petrusha <[email protected]> * Update xml/System.Runtime.InteropServices/GCHandle.xml Co-Authored-By: Ron Petrusha <[email protected]> * Update xml/System.Runtime.InteropServices/GCHandle.xml Co-Authored-By: Ron Petrusha <[email protected]>
1 parent e7afa9c commit d3af8a5

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

xml/System.Runtime.InteropServices/GCHandle.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,15 @@
107107
</ReturnValue>
108108
<Parameters />
109109
<Docs>
110-
<summary>Retrieves the address of an object in a <see cref="F:System.Runtime.InteropServices.GCHandleType.Pinned" /> handle.</summary>
111-
<returns>The address of the pinned object as an <see cref="T:System.IntPtr" />.</returns>
110+
<summary>Retrieves the address of object data in a <see cref="F:System.Runtime.InteropServices.GCHandleType.Pinned" /> handle.</summary>
111+
<returns>The address of the pinned data object.</returns>
112112
<remarks>
113113
<format type="text/markdown"><![CDATA[
114114
115115
## Remarks
116-
This method is used to get a stable pointer to the object. Pinning an object prevents the garbage collector from moving it around in memory, thereby reducing the efficiency of the garbage collector.
116+
This method is used to get a stable pointer to the object data. For arrays, this method returns the address of the first element. For strings, this method returns the address of the first character.
117+
118+
Pinning an object prevents the garbage collector from moving it around in memory, thereby reducing the efficiency of the garbage collector.
117119
118120
]]></format>
119121
</remarks>

0 commit comments

Comments
 (0)