DateAndTime.TimeValue Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a Date value containing the time information represented by a string, with the date information set to January 1 of the year 1.

Namespace:   Microsoft.VisualBasic
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public static DateTime TimeValue(
	string StringTime
)

Parameters

StringTime
Type: System.String

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.

Return Value

Type: System.DateTime

Returns a Date value containing the time information represented by a string, with the date information set to January 1 of the year 1.

Exception Condition
InvalidCastException

StringTime includes invalid date information.

You can enter valid times using a 12-hour or 24-hour clock. For example, "2:24 P.M." and "14:24" are both valid StringTime arguments.

If the StringTime argument includes date information, TimeValue does not include it in the returned value. However, if StringTime includes invalid date information, for example "January 32," an InvalidCastException error occurs.

The following example uses the TimeValue function to convert a string to a time. You can also use date literals to directly assign a time to a Date variable.

Dim thisTime As Date
thisTime = TimeValue("4:35:17 PM")

.NET Framework
Available since 1.1
Silverlight
Available since 2.0
Return to top
Show: