VirtualString.EpochFormat(String, String) Method

Top 

Description

Returns a formatted string representing an epoch in time. The format string formatSpecification can include the date and time formats shown in the "Parsing Dates and Times" reference in the Help File, including month, day, year, hours, minutes, and seconds. The conversion string timeFrameConversion specifies the time system conversion that is applied. For example, for a calling VirtualString Epoch in UTC, and an output String in UT1 time, the timeFrameConversion would be "UTC-UT1".

 

This method has been Deprecated. Please use String.EpochScan.EpochFormat instead.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode.

 

Method Signature

VirtualString.EpochFormat(

String formatSpecification,


String timeFrameConversion)

 

Arguments

formatSpecification


Description:

Specifies the format of the output String. The format specification can include the date and time formats shown in the "Parsing Dates and Times" reference in the Help File, including month, day, year, hours, minutes, and seconds. The user can also include custom characters by surrounding them with **asterisks**. If a format string is not specified, the format "Mmm DD YYYY hh:mm:ss.fs" will be used.

 

timeFrameConversion


Description:

Specifies the time system to convert to. If only one time system is specified (e.g., "UT1"), then "UTC-" is prepended to the conversion string (e.g., "UTC-UT1").

Valid Values:

Value

Label

"TAI"

TAI

"UT1"

UT1

"UTC"

UTC

"UTC-UTC"

UTC-UTC

"UTC-TAI"

UTC-TAI

"UTC-UT1"

UTC-UT1

"TAI-TAI"

TAI-TAI

"TAI-UT1"

TAI-UT1

"TAI-UTC"

TAI-UTC

"UT1-UT1"

UT1-UT1

"UT1-TAI"

UT1-TAI

"UT1-UTC"

UT1-UTC

 

 

Return Value

Type:

string

 

Returns a formatted string representing an epoch in time.

 

Syntax

myString1 = myString2.ToLower.EpochFormat(myString3, myString4);

 

See also

VirtualString Object

VirtualString.EpochFormat

Parsing Dates and Times