diff options
| author | dotnet bot <dotnet-bot@dotnetfoundation.org> | 2018-04-16 14:47:39 -0700 |
|---|---|---|
| committer | Ahson Khan <ahkha@microsoft.com> | 2018-04-16 14:47:39 -0700 |
| commit | dbbb54c5e3e7db8d87521e799141d99aa24607c0 (patch) | |
| tree | 8ccc04bbb4ba86862924926b5b1096a62e999ab0 /src/mscorlib | |
| parent | 602536f6652c66f3627eefcf35c5ef112d1c6ea0 (diff) | |
| download | coreclr-dbbb54c5e3e7db8d87521e799141d99aa24607c0.tar.gz coreclr-dbbb54c5e3e7db8d87521e799141d99aa24607c0.tar.bz2 coreclr-dbbb54c5e3e7db8d87521e799141d99aa24607c0.zip | |
Update xml comment for {ReadOnly}Memory.Pin method (dotnet/corefx#29137) (#17593)
Signed-off-by: dotnet-bot-corefx-mirror <dotnet-bot@microsoft.com>
Diffstat (limited to 'src/mscorlib')
| -rw-r--r-- | src/mscorlib/shared/System/Memory.cs | 5 | ||||
| -rw-r--r-- | src/mscorlib/shared/System/ReadOnlyMemory.cs | 5 |
2 files changed, 8 insertions, 2 deletions
diff --git a/src/mscorlib/shared/System/Memory.cs b/src/mscorlib/shared/System/Memory.cs index 26f4e4ce19..98ec23fd67 100644 --- a/src/mscorlib/shared/System/Memory.cs +++ b/src/mscorlib/shared/System/Memory.cs @@ -318,8 +318,11 @@ namespace System /// <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/mscorlib/shared/System/ReadOnlyMemory.cs b/src/mscorlib/shared/System/ReadOnlyMemory.cs index 3e7884528e..ae8a7c3001 100644 --- a/src/mscorlib/shared/System/ReadOnlyMemory.cs +++ b/src/mscorlib/shared/System/ReadOnlyMemory.cs @@ -235,8 +235,11 @@ namespace System /// <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() { |