TimeSpan.ToString Method (String, IFormatProvider)

Converts the value of the current TimeSpan object to its equivalent string representation by using the specified format and culture-specific formatting information.

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

'Declaration
Public Function ToString ( _
	format As String, _
	formatProvider As IFormatProvider _
) As String

Parameters

format
Type: System.String

A standard or custom TimeSpan format string.

formatProvider
Type: System.IFormatProvider

An object that supplies culture-specific formatting information.

Return Value

Type: System.String
The string representation of the current TimeSpan value, as specified by format and formatProvider.

Implements

IFormattable.ToString(String, IFormatProvider)

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.

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 formatProvider parameter is an IFormatProvider implementation that provides culture-specific information about the format of the returned string. The formatProvider parameter can be any of the following:

If formatProvider is Nothing, the DateTimeFormatInfo object that is associated with the current culture is used. If format is a custom format string, the formatProvider parameter is ignored.

The following example calls the ToString(String, IFormatProvider) method to format two time intervals. The example calls the method twice for each format string, first to display it using the conventions of the en-US culture and then to display it using the conventions of the fr-FR culture.

Imports System.Globalization

Module Example
   Public Sub Main()
      Dim intervals() As TimeSpan = { New TimeSpan(38, 30, 15), 
                                      New TimeSpan(16, 14, 30) } 
      Dim cultures() As CultureInfo = { New CultureInfo("en-US"), 
                                        New CultureInfo("fr-FR") }
      Dim formats() As String = {"c", "g", "G", "hh\:mm\:ss" }
      Console.WriteLine("{0,12}      Format  {1,22}  {2,22}", 
                        "Interval", cultures(0).Name, cultures(1).Name)
      Console.WriteLine()
      For Each interval In intervals
         For Each fmt In formats
            Console.WriteLine("{0,12}  {1,10}  {2,22}  {3,22}", 
                              interval, fmt, 
                              interval.ToString(fmt, cultures(0)), 
                              interval.ToString(fmt, cultures(1)))
         Next
         Console.WriteLine()
      Next                                                                                                                                             
   End Sub 
End Module 
' The example displays the following output: 
'        Interval      Format                   en-US                   fr-FR 
'     
'      1.14:30:15           c              1.14:30:15              1.14:30:15 
'      1.14:30:15           g              1:14:30:15              1:14:30:15 
'      1.14:30:15           G      1:14:30:15.0000000      1:14:30:15,0000000 
'      1.14:30:15  hh\:mm\:ss                14:30:15                14:30:15 
'     
'        16:14:30           c                16:14:30                16:14:30 
'        16:14:30           g                16:14:30                16:14:30 
'        16:14:30           G      0:16:14:30.0000000      0:16:14:30,0000000 
'        16:14:30  hh\:mm\:ss                16:14:30                16:14:30

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft