ISpanFormattable.TryFormat Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Tries to format the value of the current instance into the provided span of characters.

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

public bool TryFormat (Span<char> destination, out int charsWritten, ReadOnlySpan<char> format, IFormatProvider? provider);

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

Public Function TryFormat (destination As Span(Of Char), ByRef charsWritten As Integer, format As ReadOnlySpan(Of Char), provider As IFormatProvider) As Boolean

Parameters

destination

Span<Char>

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

charsWritten

Int32

When this method returns, contains the number of characters that were written in destination.

format

ReadOnlySpan<Char>

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

provider

IFormatProvider

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

Returns

Boolean

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) 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.