Export (0) Print
Expand All

TimeSpan.ToString Method (String)

Converts the value of the current TimeSpan object to its equivalent string representation by using the specified format.

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

'Declaration
Public Function ToString ( _
	format As String _
) As String

Parameters

format
Type: System.String

A standard or custom TimeSpan format string.

Return Value

Type: System.String
The string representation of the current TimeSpan value in the format specified by the format parameter.

ExceptionCondition
FormatException

The format parameter is not recognized or is not supported.

The format parameter can be any valid standard or custom format specifier for TimeSpan values. If format is equal to String.Empty or is Nothing, the return value of the current TimeSpan object is formatted with the common format specifier ("c"). If format is any other value, the method throws a FormatException.

If format is a standard format string, the format of the returned string is defined by the formatting conventions of the current culture.

Important noteImportant

The custom format strings for TimeSpan values do not include a date or time separator. If you want to include these elements in your format string, you must treat them as character literals. See the example for an illustration, and see the Custom TimeSpan Format Strings topic for more information.

The .NET Framework provides extensive formatting support, which is described in greater detail in the following formatting topics:

The following example uses standard and custom TimeSpan format strings to display the string representation of each element in an array of TimeSpan values

Module Example
   Public Sub Main()
      Dim spans() As TimeSpan = { TimeSpan.Zero, New TimeSpan(-14, 0, 0, 0, 0), 
                                  New TimeSpan(1, 2, 3), 
                                  New TimeSpan(0, 0, 0, 0, 250), 
                                  New TimeSpan(99, 23, 59, 59, 999),
                                  New TimeSpan(3, 0, 0), 
                                  New TimeSpan(0, 0, 0, 0, 25) }
      Dim fmts() As String = { "c", "g", "G", "hh\:mm\:ss", "%m' min.'" }
      For Each span As TimeSpan In spans
         For Each fmt As String In fmts
            Console.WriteLine("{0}: {1}", fmt, span.ToString(fmt))
         Next
         Console.WriteLine()         
      Next 
   End Sub 
End Module 
' The example displays the following output: 
'       c: 00:00:00 
'       g: 0:00:00 
'       G: 0:00:00:00.0000000 
'       hh\:mm\:ss: 00:00:00 
'       %m' min.': 0 min. 
'        
'       c: -14.00:00:00 
'       g: -14:0:00:00 
'       G: -14:00:00:00.0000000 
'       hh\:mm\:ss: 00:00:00 
'       %m' min.': 0 min. 
'        
'       c: 01:02:03 
'       g: 1:02:03 
'       G: 0:01:02:03.0000000 
'       hh\:mm\:ss: 01:02:03 
'       %m' min.': 2 min. 
'        
'       c: 00:00:00.2500000 
'       g: 0:00:00.25 
'       G: 0:00:00:00.2500000 
'       hh\:mm\:ss: 00:00:00 
'       %m' min.': 0 min. 
'        
'       c: 99.23:59:59.9990000 
'       g: 99:23:59:59.999 
'       G: 99:23:59:59.9990000 
'       hh\:mm\:ss: 23:59:59 
'       %m' min.': 59 min. 
'        
'       c: 03:00:00 
'       g: 3:00:00 
'       G: 0:03:00:00.0000000 
'       hh\:mm\:ss: 03:00:00 
'       %m' min.': 0 min. 
'        
'       c: 00:00:00.0250000 
'       g: 0:00:00.025 
'       G: 0:00:00:00.0250000 
'       hh\:mm\:ss: 00:00:00 
'       %m' min.': 0 min.

.NET Framework

Supported in: 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft