Send feedback on this topic.
Teradata.Client.Provider
ToString(String,IFormatProvider) Method



Teradata.Client.Provider Namespace > TdPeriodTime Structure > ToString Method : ToString(String,IFormatProvider) Method
The DateTime format string that will be used to format the TdPeriodTime.
The culture specific information. The culture specific information is not used when converting a Period into a string.
TdPeriodTime is converted into the equivalent String representation using the specified format and culture information.
Syntax
'Declaration
 
Public Overloads Function ToString( _
   ByVal format As String, _
   ByVal formatProvider As IFormatProvider _
) As String
'Usage
 
Dim instance As TdPeriodTime
Dim format As String
Dim formatProvider As IFormatProvider
Dim value As String
 
value = instance.ToString(format, formatProvider)
public string ToString( 
   string format,
   IFormatProvider formatProvider
)
public:
String^ ToString( 
   String^ format,
   IFormatProvider^ formatProvider
) 

Parameters

format
The DateTime format string that will be used to format the TdPeriodTime.
formatProvider
The culture specific information. The culture specific information is not used when converting a Period into a string.

Return Value

A string representation of the period contained in TdPeriodTime.
Remarks

When a TdPeriodTime is converted to a string, both the beginning and ending bound will be included in the returning string. The format of the string will be:

 (Beginning Bound, Ending Bound)   

The format specifier affects the string representation of the beginning and ending bounds of the period. Cultural information specified in the formatProvider is ignored.

If the format parameter is null, the string representation of TdPeriodTime will be equivalent to the "G" format specifier which is

    (HH:mm:ss.ffffff, HH:mm:ss.ffffff)   

The following format specifiers are supported by TdPeriodTime:

Format Specifier Description
G

The ANSI representation of the period: /// (HH:mm:ss.ffffff, HH:mm:ss.ffffff).

Example: (10:21:31.002, 12:45:00.212).

l or L

The SQL literal representation of the period: PERIOD'(HH:mm:ss.ffffff, HH:mm:ss.ffffff)'.

Example: PERIOD'(10:21:31.002, 12:45:00.212)'.

Requirements

Target Platforms: Windows 8.1, Windows 10, Windows Server 2012 R2, Windows Server 2016, Windows Server 2019

See Also

Reference

TdPeriodTime Structure
TdPeriodTime Members
Overload List
ToString(String,IFormatProvider) Method