ReadOnlyMemory<T>.Pin Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

ReadOnlyMemory.cs

Creates a handle for the memory.

public:
 System::Buffers::MemoryHandle Pin();

public System.Buffers.MemoryHandle Pin ();

member this.Pin : unit -> System.Buffers.MemoryHandle

Public Function Pin () As MemoryHandle

Returns

MemoryHandle

A handle for the memory.

Exceptions

ArgumentException

An instance with nonprimitive (non-blittable) members cannot be pinned.

Remarks

Important

The garbage collector will not move the memory until the returned MemoryHandle is disposed, which enables taking and using the memory's address.