Rune.TryEncodeToUtf8(Span<Byte>, Int32) Method

Definition

Namespace:

System.Text

Assembly:

System.Runtime.dll

Source:

Rune.cs

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

public:
 bool TryEncodeToUtf8(Span<System::Byte> destination, [Runtime::InteropServices::Out] int % bytesWritten);

public bool TryEncodeToUtf8 (Span<byte> destination, out int bytesWritten);

member this.TryEncodeToUtf8 : Span<byte> * int -> bool

Public Function TryEncodeToUtf8 (destination As Span(Of Byte), ByRef bytesWritten As Integer) As Boolean

Parameters

destination

Span<Byte>

The buffer to which to write the UTF-8 encoded value.

bytesWritten

Int32

The number of Byte 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 Utf8SequenceLength property can be queried ahead of time to determine the required size of the destination buffer.