IPinnable.Pin(Int32) Method

Reference

Definition

Namespace:: System.Buffers

Assembly:: System.Runtime.dll

Assembly:: System.Memory.dll

Assembly:: netstandard.dll

Package:: System.Memory v4.5.5

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.

Pins a block of memory.

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

public System.Buffers.MemoryHandle Pin (int elementIndex);

abstract member Pin : int -> System.Buffers.MemoryHandle

Public Function Pin (elementIndex As Integer) As MemoryHandle

Parameters

elementIndex: Int32

The offset to the element within the memory buffer to which the returned MemoryHandle points.

Returns

MemoryHandle

A handle to the block of memory.

Remarks

A developer can access an object that implements the IPinnable interface without pinning it only through managed APIs. Pinning is required for access by unmanaged APIs.

Call this method to indicate that the IPinnable object cannot be moved by the garbage collector so that the address of the pinned object can be used.

Applies to