IUtf8SpanFormattable.TryFormat Method (System) (original) (raw)

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Tries to format the value of the current instance as UTF-8 into the provided span of bytes.

public:
 bool TryFormat(Span<System::Byte> utf8Destination, [Runtime::InteropServices::Out] int % bytesWritten, ReadOnlySpan<char> format, IFormatProvider ^ provider);

public bool TryFormat(Span<byte> utf8Destination, out int bytesWritten, ReadOnlySpan<char> format, IFormatProvider? provider);

abstract member TryFormat : Span<byte> * int * ReadOnlySpan<char> * IFormatProvider -> bool

Public Function TryFormat (utf8Destination As Span(Of Byte), ByRef bytesWritten As Integer, format As ReadOnlySpan(Of Char), provider As IFormatProvider) As Boolean

Parameters

utf8Destination

Span<Byte>

The span in which to write this instance's value formatted as a span of bytes.

bytesWritten

Int32

When this method returns, contains the number of bytes that were written in utf8Destination.

format

ReadOnlySpan<Char>

A span containing the characters that represent a standard or custom format string that defines the acceptable format for utf8Destination.

provider

IFormatProvider

An optional object that supplies culture-specific formatting information for utf8Destination.

Returns

true if the formatting was successful; otherwise, false.

Remarks

An implementation of this interface should produce the same string of characters as an implementation of ToString(String, IFormatProvider) or TryFormat(Span, Int32, ReadOnlySpan, IFormatProvider) on the same type. TryFormat should return false only if there is not enough space in the destination buffer; any other failures should throw an exception.

Applies to