Memory<T>.Pin Method

Reference

Definition

Namespace:: System

Assembly:: System.Runtime.dll

Assembly:: System.Memory.dll

Assembly:: netstandard.dll

Package:: System.Memory v4.6.0

Source:: Memory.cs

Source:: Memory.cs

Source:: Memory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates a handle for the Memory<T> object.

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<T> object.

Exceptions

ArgumentException

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

Remarks

The garbage collector will not move the memory until the returned MemoryHandle object is disposed. This enables you to retrieve and use the memory's address.

Applies to

Jaa