GCHandle.AddrOfPinnedObject Method

Definition

Retrieves the address of object data in a Pinned handle.

C#
[System.Security.SecurityCritical]
public IntPtr AddrOfPinnedObject();
C#
public IntPtr AddrOfPinnedObject();
C#
public readonly IntPtr AddrOfPinnedObject();

Returns

IntPtr

The address of the pinned data object.

Attributes

Exceptions

The handle is any type other than Pinned.

Remarks

This method is used to get a stable pointer to the object data. For arrays, this method returns the address of the first element. For strings, this method returns the address of the first character.

Pinning an object prevents the garbage collector from moving it around in memory, thereby reducing the efficiency of the garbage collector.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0

See also