Update xml comment for {ReadOnly}Memory.Pin method (dotnet/corefxdotn…

…et/coreclr#29137) (dotnet/coreclr#17593) Signed-off-by: dotnet-bot-corefx-mirror <[email protected]> Commit migrated from dotnet/coreclr@dbbb54c
waiyiptam · Apr 16, 2018 · 11467bf · 11467bf
1 parent 7937336
commit 11467bf
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/coreclr/src/mscorlib/shared/System/Memory.cs b/src/coreclr/src/mscorlib/shared/System/Memory.cs
@@ -318,8 +318,11 @@ public Span<T> Span
 
         /// <summary>
         /// Creates a handle for the memory.
-        /// The GC will not move the array until the returned <see cref="MemoryHandle"/>
+        /// The GC will not move the memory until the returned <see cref="MemoryHandle"/>
         /// is disposed, enabling taking and using the memory's address.
+        /// <exception cref="System.ArgumentException">
+        /// An instance with nonprimitive (non-blittable) members cannot be pinned.
+        /// </exception>
         /// </summary>
         public unsafe MemoryHandle Pin()
         {

diff --git a/src/coreclr/src/mscorlib/shared/System/ReadOnlyMemory.cs b/src/coreclr/src/mscorlib/shared/System/ReadOnlyMemory.cs
@@ -235,8 +235,11 @@ public ReadOnlySpan<T> Span
 
         /// <summary>
         /// Creates a handle for the memory.
-        /// The GC will not move the array until the returned <see cref="MemoryHandle"/>
+        /// The GC will not move the memory until the returned <see cref="MemoryHandle"/>
         /// is disposed, enabling taking and using the memory's address.
+        /// <exception cref="System.ArgumentException">
+        /// An instance with nonprimitive (non-blittable) members cannot be pinned.
+        /// </exception>
         /// </summary>
         public unsafe MemoryHandle Pin()
         {