TaskLoggingHelper.FormatString Method

Article
05/05/2015

Formats the given string using the given arguments.

MSBuild is now included in Visual Studio instead of the .NET Framework. You can use MSBuild 12.0 side-by-side with versions previously deployed with the .NET Framework.For more information, see What's New in MSBuild 12.0.

Namespace: Microsoft.Build.Utilities
Assembly: Microsoft.Build.Utilities.Core (in Microsoft.Build.Utilities.Core.dll)

Syntax

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

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

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

abstract FormatString : 
        unformatted:string * 
        args:Object[] -> string  
override FormatString : 
        unformatted:string * 
        args:Object[] -> string

public function FormatString(
    unformatted : String, 
    ... args : Object[]
) : String

Parameters

unformatted
Type: System.String

The string to format.

args
Type: array<System.Object[]

Arguments for formatting.

Return Value

Type: System.String
The formatted string.

Exceptions

Exception	Condition
ArgumentNullException	unformatted is nulla null reference (Nothing in Visual Basic).

Remarks

The culture of the current thread is used for formatting.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see dd66cd4c-b087-415f-9c3e-94e3a1835f74.

Share via