TaskLoggingHelperExtension.FormatResourceString(String, Object[]) Method

Reference

Definition

Namespace:: Microsoft.Build.Tasks

Assembly:: Microsoft.Build.Tasks.Core.dll

Assembly:: Microsoft.Build.Tasks.dll

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

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

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

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

Package:: Microsoft.Build.Tasks.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.

Loads the specified resource string and optionally formats it using the given arguments. The current thread's culture is used for formatting.

This API supports the product infrastructure and is not intended to be used directly from your code.

public:
 override System::String ^ FormatResourceString(System::String ^ resourceName, ... cli::array <System::Object ^> ^ args);

public override string FormatResourceString (string resourceName, params object[] args);

override this.FormatResourceString : string * obj[] -> string

Public Overrides Function FormatResourceString (resourceName As String, ParamArray args As Object()) As String

Parameters

resourceName: String

The name of the string resource to load.

args: Object[]

Optional arguments for formatting the loaded string.

Returns

String

The formatted string.

Exceptions

ArgumentNullException

Thrown when resourceName is null.

ArgumentException

Thrown when the string resource indicated by resourceName does not exist.

InvalidOperationException

Thrown when the TaskResources property of the owner task is not set.

Remarks

1) This method requires the owner task to have registered its resources either via the Task (or TaskMarshalByRef) base class constructor, or the "Task.TaskResources" (or "AppDomainIsolatedTask.TaskResources") property. 2) This method is thread-safe.

Applies to