TaskLoggingHelper.FormatString(String, Object[]) Method

Reference

Definition

Namespace:: Microsoft.Build.Utilities

Assembly:: Microsoft.Build.Utilities.Core.dll

Assembly:: Microsoft.Build.Utilities.dll

Assemblies:: Microsoft.Build.Utilities.dll, Microsoft.Build.Utilities.v3.5.dll

Assembly:: Microsoft.Build.Utilities.v4.0.dll

Package:: Microsoft.Build.Utilities.Core v15.9.20

Package:: Microsoft.Build.Utilities.Core v16.11.0

Package:: Microsoft.Build.Utilities.Core v17.9.5

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.

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.

Applies to