ToString(String) Method

TdTimeWithTimeZone 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 TdTimeWithTimeZone
Dim format As String
Dim value As String
 
value = instance.ToString(format)

public string ToString( 
   string format
)

public:
String^ ToString( 
   String^ format
)

format: The format string that will be used to format the TdTimeWithTimeZone.

A string representation of the date in TdTimeWithTimeZone.

Exceptions

Exception	Description
System.FormatException	The specified format specifier is not supported.

Remarks

If the format parameter is null, the format of the string representation of the time will be "HH:mm.ffffff<+/->hh:mm".

The format specifiers that will be supported are as follows:

Format Specifier	Description
G	The ANSI representation of the time. "HH:mm:ss.ffffff<+/->hh:mm". The number of digits in the fractional seconds will depend upon the Scale of the time. Cultural information is ignored in this conversion. The number of digits that will appear in the fractional seconds is dependent on the TdTimeWithTimeZone.Scale. For example, if the Scale is set to 4, four digits will appear in the fraction.
l or L	The Teradata literal representation of Time With Time Zone.
t	The short time pattern --"h:mm tt"
T	The long time patterm --"h:mm:ss tt"

If this instance is TdTimeWithTimeZone.Null, a string that contains "Null" will be returned.

For additional information about the supported format specifiers refer to Globalization.DateTimeFormatInfo in the MSDN documentation.

Requirements

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