String.Format Method (IFormatProvider, String, Object[])

Replaces the format items in a specified string with the string representations of corresponding objects in a specified array. A parameter supplies culture-specific formatting information.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

public static string Format(
	IFormatProvider provider,
	string format,
	params Object[] args
)

Parameters

provider
Type: System.IFormatProvider

An object that supplies culture-specific formatting information.

format
Type: System.String

A composite format string.

args
Type: System.Object[]

An object array that contains zero or more objects to format.

Return Value

Type: System.String
A copy of format in which the format items have been replaced by the string representation of the corresponding objects in args.

ExceptionCondition
ArgumentNullException

format or args is null.

FormatException

format is invalid.

-or-

The index of a format item is less than zero, or greater than or equal to the length of the args array.

NoteNote

For examples and comprehensive usage information about this and other overloads of the Format method, see the Format overload summary.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft