TimeUtilities.TimeIntervalToString(Variable, Variable, String) Method

Top

Description

Returns a formatted String representing the specified time interval. The input time interval has units specified by the intervalUnits argument.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Method Signature

TimeUtilities.TimeIntervalToString(	Variable timeInterval,
	Variable intervalUnits,
	String format)

Arguments

timeInterval
Description:	The time interval value that will be converted to a string format.
Units:	day

intervalUnits

Description:

The time units of the input interval value.

Valid Values:

Value	Label
0	Days
1	Hours
2	Minutes
3	Seconds
4	Milliseconds

format
Description:	Specifies the format of the output String. The format specification can include the time formats shown in the "Parsing Dates and Times" reference in the Help File, including days, hours, minutes, and seconds.

Return Value

Type:

string

Returns a formatted String representing the specified time interval.

Syntax

myString1 = TimeTools.TimeIntervalToString(myVariable1, myVariable2, myString2);