DateTime::ToString Method (IFormatProvider)
Updated: February 2010
Converts the value of the current DateTime object to its equivalent string representation using the specified culture-specific format information.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- provider
- Type: System::IFormatProvider
An object that supplies culture-specific formatting information.
Return Value
Type: System::StringA string representation of value of the current DateTime object as specified by provider.
Implements
IConvertible::ToString(IFormatProvider)| Exception | Condition |
|---|---|
| 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:
A CultureInfo object that represents the culture whose formatting conventions are to be reflected in the returned string. The DateTimeFormatInfo object returned by the CultureInfo::DateTimeFormat property defines the formatting of the returned string.
A DateTimeFormatInfo object that defines the format of date and time data.
A custom object that implements the IFormatProvider interface. Its GetFormat method returns a DateTimeFormatInfo object that provides formatting information.
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.
The following example displays the string representation of a date and time using CultureInfo objects that represent five different cultures.
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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
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.