This documentation is archived and is not being maintained.

DateTime::ToString Method (IFormatProvider)

Converts the value of the current DateTime object to its equivalent string representation using the specified culture-specific format information.

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

public:
virtual String^ ToString(
	IFormatProvider^ provider
) sealed

Parameters

provider
Type: System::IFormatProvider
An object that supplies culture-specific formatting information.

Return Value

Type: System::String
A string representation of value of the current DateTime object as specified by provider.

Implements

IConvertible::ToString(IFormatProvider)

ExceptionCondition
ArgumentOutOfRangeException

The date and time is outside the range of dates supported by the calendar used by provider.

The value of the current DateTime object is formatted using the general date and time format specifier ('G'), which formats output using the short date pattern and the long time pattern.

The format of the short date and long time pattern is defined by the provider parameter. The provider parameter can be any of the following:

If provider is nullptr, the DateTimeFormatInfo object associated with the current culture is used. For more information, see CultureInfo::CurrentCulture.

Notes to Callers

The ToString(IFormatProvider) method returns the string representation of the date and time in the calendar used by the culture represented by the provider parameter. Its calendar is defined by the Calendar property. If the value of the current DateTime instance is earlier than Calendar::MinSupportedDateTime or later than Calendar::MaxSupportedDateTime, the method throws an ArgumentOutOfRangeException. The following example provides an illustration. It attempts to format a date that is outside the range of the JapaneseCalendar class.

No code example is currently available or this language may not be supported.

The following example displays the string representation of a date and time using CultureInfo objects that represent five different cultures.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 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

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.
Show: