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 (in microsoft.build.utilities.dll)

public virtual string FormatResourceString (
	string resourceName,
	params Object[] args
)
public String FormatResourceString (
	String resourceName, 
	Object[] args
)
public function FormatResourceString (
	resourceName : String, 
	... args : Object[]
) : String
Not applicable.

Parameters

resourceName

The name of the string resource to load.

args

Optional arguments for formatting the loaded string.

Return Value

The formatted string.

Exception typeCondition

ArgumentNullException

resourceName is a null reference (Nothing in Visual Basic).

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 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: