This documentation is archived and is not being maintained.

TaskLoggingHelper.FormatResourceString Method

Loads the specified resource string and optionally formats it using the given arguments.

Namespace:  Microsoft.Build.Utilities
Assembly:  Microsoft.Build.Utilities.v4.0 (in Microsoft.Build.Utilities.v4.0.dll)

public virtual string FormatResourceString(
	string resourceName,
	params Object[] args


Type: System.String
The name of the string resource to load.
Type: System.Object[]
Optional arguments for formatting the loaded string.

Return Value

Type: System.String
The formatted string.


The string resource indicated by resourceName does not exist.


The TaskResources property of the owner task is not set.


resourceName is null.

The culture of the current thread is used for formatting.

This method requires the owner task to have registered its resources with either the Task base class constructor, or the TaskResources property.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.