DateTime.ToShortTimeString Method ()

 

Converts the value of the current DateTime object to its equivalent short time string representation.

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

Public Function ToShortTimeString As String

Return Value

Type: System.String

A string that contains the short time string representation of the current DateTime object.

The value of the current DateTime object is formatted using the pattern defined by the DateTimeFormatInfo.ShortTimePattern property associated with the current thread culture. The return value is identical to the value returned by specifying the "t" standard DateTime format string with the ToString(String) method.

System_CAPS_importantImportant

The string returned by the ToShortTimeString method is culture-sensitive. It reflects the pattern defined by the current culture's DateTimeFormatInfo object. For example, for the en-US culture, the standard short time pattern is "h:mm tt"; for the de-DE culture, it is "HH:mm"; for the ja-JP culture, it is "H:mm". The specific format string on a particular computer can also be customized so that it differs from the standard short time format string.

For more information about the current thread culture, see the CurrentCulture property. For more information about format characters, format patterns, and the output they produce, see the Formatting Types in the .NET Framework topic. For more information about changing the format pattern associated with a format character, see the DateTimeFormatInfo class.

The following example demonstrates the ToShortTimeString method.

' This code example demonstrates the DateTime.ToLongDateString(),
' DateTime.ToLongTimeString(), DateTime.ToShortDateString(), and
' DateTime.ToShortTimeString() methods.

Imports System
Imports System.Threading
Imports System.Globalization

Class Sample
    Public Shared Sub Main() 
        Dim msg1 As String = _
           "The date and time patterns are defined in the DateTimeFormatInfo " & vbCrLf & _
           "object associated with the current thread culture." & vbCrLf

        ' Initialize a DateTime object.
        Console.WriteLine("Initialize the DateTime object to May 16, 2001 3:02:15 AM." & vbCrLf)
        Dim myDateTime As New DateTime(2001, 5, 16, 3, 2, 15)

        ' Identify the source of the date and time patterns.
        Console.WriteLine(msg1)

        ' Display the name of the current culture.
        Dim ci As CultureInfo = Thread.CurrentThread.CurrentCulture
        Console.WriteLine("Current culture: ""{0}" & vbCrLf, ci.Name)

        ' Display the long date pattern and string.
        Console.WriteLine("Long date pattern: ""{0}""", ci.DateTimeFormat.LongDatePattern)
        Console.WriteLine("Long date string:  ""{0}" & vbCrLf, myDateTime.ToLongDateString())

        ' Display the long time pattern and string.
        Console.WriteLine("Long time pattern: ""{0}""", ci.DateTimeFormat.LongTimePattern)
        Console.WriteLine("Long time string:  ""{0}" & vbCrLf, myDateTime.ToLongTimeString())

        ' Display the short date pattern and string.
        Console.WriteLine("Short date pattern: ""{0}""", ci.DateTimeFormat.ShortDatePattern)
        Console.WriteLine("Short date string:  ""{0}" & vbCrLf, myDateTime.ToShortDateString())

        ' Display the short time pattern and string.
        Console.WriteLine("Short time pattern: ""{0}""", ci.DateTimeFormat.ShortTimePattern)
        Console.WriteLine("Short time string:  ""{0}" & vbCrLf, myDateTime.ToShortTimeString())
    End Sub 'Main
End Class 'Sample

'
'This code example produces the following results:
'
'Initialize the DateTime object to May 16, 2001 3:02:15 AM
'
'The date and time patterns are defined in the DateTimeFormatInfo
'object associated with the current thread culture.
'
'Current culture: "en-US"
'
'Long date pattern: "dddd, MMMM dd, yyyy"
'Long date string:  "Wednesday, May 16, 2001"
'
'Long time pattern: "h:mm:ss tt"
'Long time string:  "3:02:15 AM"
'
'Short date pattern: "M/d/yyyy"
'Short date string:  "5/16/2001"
'
'Short time pattern: "h:mm tt"
'Short time string:  "3:02 AM"
'

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