Rune.TryEncodeToUtf16(Span<Char>, Int32) Method

Definition

Namespace:

System.Text

Assembly:

System.Runtime.dll

Source:

Rune.cs

Encodes this Rune to a UTF-16 encoded destination buffer.

public:
 bool TryEncodeToUtf16(Span<char> destination, [Runtime::InteropServices::Out] int % charsWritten);

public bool TryEncodeToUtf16 (Span<char> destination, out int charsWritten);

member this.TryEncodeToUtf16 : Span<char> * int -> bool

Public Function TryEncodeToUtf16 (destination As Span(Of Char), ByRef charsWritten As Integer) As Boolean

Parameters

destination

Span<Char>

The buffer to which to write this value as UTF-16 encoded value.

charsWritten

Int32

The number of Char values written to destination, or 0 if the destination buffer is not large enough to contain the output.

Returns

Boolean

true if the value was written to the buffer; otherwise, false.

Remarks

The Utf16SequenceLength property can be queried ahead of time to determine the required size of the destination buffer.