This documentation is archived and is not being maintained.

Convert::ToDateTime Method (String, IFormatProvider)

Converts the specified string representation of a number to an equivalent date and time, using the specified culture-specific formatting information.

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

public:
static DateTime ToDateTime(
	String^ value, 
	IFormatProvider^ provider
)

Parameters

value
Type: System::String
A string that contains a date and time to convert.
provider
Type: System::IFormatProvider
An object that supplies culture-specific formatting information.

Return Value

Type: System::DateTime
The date and time equivalent of the value of value, or the date and time equivalent of DateTime::MinValue if value is nullptr.

ExceptionCondition
FormatException

value is not a properly formatted date and time string.

The return value is the result of invoking the DateTime::Parse(String, IFormatProvider) method on value.

provider is an IFormatProvider instance that obtains a DateTimeFormatInfo object. The DateTimeFormatInfo object provides culture-specific information about the format of value. If provider is nullptr, the DateTimeFormatInfo for the current culture is used.

If you prefer not to handle an exception if the conversion fails, you can call the DateTime::TryParse method instead. It returns a Boolean value that indicates whether the conversion succeeded or failed.

The following example converts string representations of date values with the ToDateTime method, using an IFormatProvider object.

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: