Extensions.DateTime.FormatDuration

Classification

Name	FormatDuration
Short Description	Give a duration in milliseconds from a time stamp.
Class	Term
Extension	OTX DateTime Extension
Group	-
Exceptions	OutOfBoundsException
Checker Rules	-
Standard Compliant	Yes

OTL Syntax

StringTerm DateTime.FormatDuration(NumericTerm duration, StringTerm format);

Description

FormatDuration returns a specified duration in milliseconds as a string representation. Formatting will be made to the format of Date Term, with the difference that the milliseconds elapsed interpreted as a duration, not the date Analog.

If the duration value is negative, the OutOfBoundsException exception will be thrown.

Return Value

The Term returns the value, see table below.

In OTX, Terms are categorized according to its return data type!

Data Type	Description
String	A formatted time.

Properties

Name	Data Type	Class	Default	Cardinality	Description
Duration	Integer	Term	-	[1]	This property represents a duration in milliseconds to a string that is formatted according to the specified rules.
Format	String	Term	-	[0..1]	User-specified format for displaying the time.

OTL Examples

/// Local Declarations

String CurrentTime;

/// Flow

CurrentTime = DateTime.FormatDuration(1000, "S,s");

See also

GetTimeStamp
FormatDate