DateTime::ToString Method (String, IFormatProvider)
Converts the value of the current DateTime object to its equivalent string representation using the specified format and culture-specific format information.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Parameters
- format
- Type: System::String
A standard or custom date and time format string (see Remarks).
- 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 the format and provider parameters.
Implements
IFormattable::ToString(String, IFormatProvider)| Exception | Condition |
|---|---|
| FormatException | The length of format is 1, and it is not one of the format specifier characters defined for DateTimeFormatInfo. -or- format does not contain a valid custom format pattern. |
| ArgumentOutOfRangeException | The date and time is outside the range of dates supported by the calendar used by provider. |
The format parameter can contain either a single format specifier character (see Standard Date and Time Format Strings) or a custom format pattern (see Custom Date and Time Format Strings). If format is nullptr or an empty string (""), the standard format specifier, 'G', is used.
The provider parameter defines the pattern that corresponds to the standard format specifiers, as well as the symbols and names of date and time components. 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 associated with the current culture is used. For more information, see CultureInfo::CurrentCulture.
Platform Notes
Silverlight for Windows Phone
The ToString(String, IFormatProvider) method returns the string representation of the date and time in the calendar used 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 UmAlQuraCalendar class.
The following example uses each of the standard date time format strings to display the string representation of a date and time for four different cultures.
The following example demonstrates different ways of formatting a DateTime value using the invariant DateTimeFormatInfo.
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.