DateTime::ToString Method (IFormatProvider)
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)
- Type: System::IFormatProvider
An object that supplies culture-specific formatting information.
Return ValueType: System::String
A string representation of value of the current DateTime object as specified by provider.
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.
The 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.