DateValue Function (Visual Basic)
Returns a Date value containing the date information represented by a string, with the time information set to midnight (00:00:00).
Public Function DateValue(ByVal StringDate As String) As DateTime
Parameters
- StringDate
Required. String expression representing a date/time value from 00:00:00 on January 1 of the year 1 through 23:59:59 on December 31, 9999.
Exceptions
Exception type |
Error number |
Condition |
|---|---|---|
StringDate includes invalid time information. |
See the "Error number" column if you are upgrading Visual Basic 6.0 applications that use unstructured error handling. (You can compare the error number against the Number Property (Err Object).) However, when possible, you should consider replacing such error control with Structured Exception Handling Overview for Visual Basic.
Remarks
If StringDate includes only numbers from 1 through 12 separated by valid date separators, DateValue recognizes the order for month, day, and year according to the Short Date format specified for your system. DateValue uses the current calendar setting from the CurrentCulture property of the CultureInfo class in the System.Globalization namespace. The default CurrentCulture values are determined by Control Panel settings. You can override the Short Date format by setting the ShortDatePattern property of the DateTimeFormatInfo class in the System.Globalization namespace.
DateValue recognizes month names in long, abbreviated, and numeric form. For example, in addition to recognizing 12/30/1991 and 12/30/91, DateValue also recognizes December 30, 1991 and Dec 30, 1991.
If the year part of StringDate is omitted, DateValue uses the current year from your computer's system date.
If the StringDate argument includes time information, DateValue does not include it in the returned value. However, if StringDate includes invalid time information, such as "89:98", an InvalidCastException error occurs.
Example
This example uses the DateValue function to convert a string to a date. You can also use date literals to directly assign a date to an Object or Date variable, for example, oldDate = #2/12/69#.
Dim oldDate As Date
oldDate = DateValue("February 12, 1969")
Requirements
Namespace: Microsoft.VisualBasic
Module: DateAndTime
Assembly: Visual Basic Runtime Library (in Microsoft.VisualBasic.dll)
See Also
Reference
DateSerial Function (Visual Basic)
TimeSerial Function (Visual Basic)
TimeValue Function (Visual Basic)