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



Teradata.Client.Provider Namespace > TdPeriodTimestamp Structure > ToString Method : ToString(String) Method
The DateTime format string that will be used to format the TdPeriodTimestamp.
TdPeriodTimestamp is converted to the equivalent String using the specified format.
Syntax
'Declaration
 
Public Overloads Function ToString( _
   ByVal format As String _
) As String
'Usage
 
Dim instance As TdPeriodTimestamp
Dim format As String
Dim value As String
 
value = instance.ToString(format)
public string ToString( 
   string format
)
public:
String^ ToString( 
   String^ format
) 

Parameters

format
The DateTime format string that will be used to format the TdPeriodTimestamp.

Return Value

A string representation of the Period.
Exceptions
ExceptionDescription
The specified format specifier is not supported.
Remarks

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

    (Beginning Bound, Ending Bound)

The format specifier is only used when formatting the string representation of the beginning and ending bounds of the period. It will not affect the format of the period.

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

    (yyyy-MM-dd HH:mm:ss.ffffff, yyyy-MM-dd HH:mm:ss.ffffff)

The following format specifiers are supported by TdPeriodTimestamp:

Format Specifier Description
G

The ANSI representation of the period: (yyyy-MM-dd HH:mm:ss.ffffff, yyyy-MM-dd HH:mm:ss.ffffff).

Example: (2008-08-14 10:21:31.002, 2008-12-15 12:45:00.212).

l or L

The Teradata database's literal representation of the period: PERIOD'(yyyy-MM-dd HH:mm:ss.ffffff, yyyy-MM-dd HH:mm:ss.ffffff)'.

Example: PERIOD'(2008-04-14 10:21:31.002, 2008-12-15 12:45:00.212)'.

Requirements

Target Platforms: Windows 7, Windows 8, Windows 8.1, Windows 10, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2

See Also

Reference

TdPeriodTimestamp Structure
TdPeriodTimestamp Members
Overload List
ToString(String) Method