TaskLoggingHelper.FormatString(String, Object[]) Method

Definition

Namespace:

Microsoft.Build.Utilities

Assembly:

Microsoft.Build.Utilities.Core.dll

Package:

Microsoft.Build.Utilities.Core v17.11.4

Source:

TaskLoggingHelper.cs

Formats the given string using the variable arguments passed in. The current thread's culture is used for formatting. Thread safe.

public:
 virtual System::String ^ FormatString(System::String ^ unformatted, ... cli::array <System::Object ^> ^ args);

public virtual string FormatString (string unformatted, params object[] args);

abstract member FormatString : string * obj[] -> string
override this.FormatString : string * obj[] -> string

Public Overridable Function FormatString (unformatted As String, ParamArray args As Object()) As String

Parameters

unformatted

String

The string to format.

args

Object[]

Arguments for formatting.

Returns

String

The formatted string.

Exceptions

ArgumentNullException

Thrown when unformatted is null.

Remarks

The culture of the current thread is used for formatting.