Edit

Share via

Complex.TryFormat Method

  • Reference

Definition

Namespace:
System.Numerics
Assembly:
System.Runtime.Numerics.dll

Overloads

TryFormat(Span<Char>, Int32, ReadOnlySpan<Char>, IFormatProvider)

Tries to format the value of the current instance into the provided span of characters.
TryFormat(Span<Byte>, Int32, ReadOnlySpan<Char>, IFormatProvider)

TryFormat(Span<Char>, Int32, ReadOnlySpan<Char>, IFormatProvider)

Source:
Complex.cs
Source:
Complex.cs
Source:
Complex.cs

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

public:
 virtual 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);
public bool TryFormat (Span<char> destination, out int charsWritten, ReadOnlySpan<char> format = default, IFormatProvider? provider = default);
abstract member TryFormat : Span<char> * int * ReadOnlySpan<char> * IFormatProvider -> bool
override this.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
Public Function TryFormat (destination As Span(Of Char), ByRef charsWritten As Integer, Optional format As ReadOnlySpan(Of Char) = Nothing, Optional provider As IFormatProvider = Nothing) 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.

Implements

TryFormat(Span<Char>, Int32, ReadOnlySpan<Char>, IFormatProvider)

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's not enough space in the destination buffer. Any other failures should throw an exception.

Applies to

TryFormat(Span<Byte>, Int32, ReadOnlySpan<Char>, IFormatProvider)

Source:
Complex.cs
Source:
Complex.cs
public bool TryFormat (Span<byte> utf8Destination, out int bytesWritten, ReadOnlySpan<char> format = default, IFormatProvider? provider = default);
abstract member TryFormat : Span<byte> * int * ReadOnlySpan<char> * IFormatProvider -> bool
override this.TryFormat : Span<byte> * int * ReadOnlySpan<char> * IFormatProvider -> bool
Public Function TryFormat (utf8Destination As Span(Of Byte), ByRef bytesWritten As Integer, Optional format As ReadOnlySpan(Of Char) = Nothing, Optional provider As IFormatProvider = Nothing) As Boolean

Parameters

utf8Destination
Span<Byte>
bytesWritten
Int32
format
ReadOnlySpan<Char>
provider
IFormatProvider

Returns

Boolean

Implements

IUtf8SpanFormattable.TryFormat(Span<Byte>, Int32, ReadOnlySpan<Char>, IFormatProvider)

Applies to