DateTime::ToString Method (String)
Converts the value of the current DateTime object to its equivalent string representation using the specified format.
Namespace: System
Assembly: mscorlib (in mscorlib.dll)
Parameters
- format
- Type: System::String
A standard or custom date and time format string (see Remarks).
Return Value
Type: System::StringA string representation of value of the current DateTime object, as specified by the format parameter.
| 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. |
The format parameter should 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) that defines the format of the returned string. If format is nullptr or an empty string, the general format specifier, 'G', is used.
This method uses formatting information derived from the current culture. For more information, see CurrentCulture.
Platform Notes
Silverlight for Windows Phone
The ToString(String) method returns the string representation of the date and time in the calendar used by the current culture. 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 HebrewCalendar class when the current culture is Hebrew (Israel).
The following example uses each of the standard date and time format strings and a selection of custom date and time format strings to display the string representation of a DateTime value. The thread current culture for the example is en-US.
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.