Rune.TryGetRuneAt(String, Int32, Rune) Method

Definition

Namespace:

System.Text

Assembly:

System.Runtime.dll

Source:

Rune.cs

Attempts to get the Rune that begins at a specified position in a string, and return a value that indicates whether the operation succeeded.

public:
 static bool TryGetRuneAt(System::String ^ input, int index, [Runtime::InteropServices::Out] System::Text::Rune % value);

public static bool TryGetRuneAt (string input, int index, out System.Text.Rune value);

static member TryGetRuneAt : string * int * Rune -> bool

Public Shared Function TryGetRuneAt (input As String, index As Integer, ByRef value As Rune) As Boolean

Parameters

input

String

The string from which to extract the rune.

index

Int32

The zero-based index from which to extract the rune.

value

Rune

When this method returns, the decoded rune.

Returns

Boolean

true if a scalar value was successfully extracted from the specified index; false if a value could not be extracted because of invalid data.

Exceptions

ArgumentNullException

input is null.

ArgumentOutOfRangeException

index is out of the range of input.

Remarks

Throws an exception if input is null or index is out of range.