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.v3.5 (in Microsoft.Build.Utilities.v3.5.dll)

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

Parameters

resourceName
Type: System.String

The name of the string resource to load.

args
Type: System.Object[]

Optional arguments for formatting the loaded string.

Return Value

Type: System.String
The formatted string.

ExceptionCondition
ArgumentNullException

resourceName is null.

ArgumentException

The string resource indicated by resourceName does not exist.

InvalidOperationException

The TaskResources property of the owner task is not set.

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.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: