String.GetPinnableReference Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

String.cs

Returns a reference to the element of the string at index zero.

This method is intended to support .NET compilers and is not intended to be called by user code.

public:
 char ^ GetPinnableReference();

public ref readonly char GetPinnableReference ();

member this.GetPinnableReference : unit -> char

Public Function GetPinnableReference () As Char

Returns

Char

A reference to the first character in the string, or a reference to the string's null terminator if the string is empty.

Exceptions

NullReferenceException

The string is null.

Remarks

The GetPinnableReference method returns a character that can be used for pinning a String in memory. It is required to support the use of a String within a fixed statement.