Difference between revisions of "Extensions.DateTime.FormatDuration"
Jump to navigation
Jump to search
| Line 3: | Line 3: | ||
{{ClassificationActivity | FormatDuration | Give a duration in milliseconds from a time stamp. | [[Term]] | [[DateTime|OTX DateTime Extension]] | - | [[OutOfBoundsException]] | - | Yes}} | {{ClassificationActivity | FormatDuration | Give a duration in milliseconds from a time stamp. | [[Term]] | [[DateTime|OTX DateTime Extension]] | - | [[OutOfBoundsException]] | - | Yes}} | ||
| − | == | + | == OTL Syntax == |
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | ||
| − | + | StringTerm = FormatDuration(IntegerTerm, StringTerm); | |
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 20: | Line 20: | ||
|} | |} | ||
| − | == Examples == | + | == OTL Examples == |
| − | + | <syntaxhighlight lang="java" enclose="div" style="font-size: medium;"> | |
| − | + | String CurrentTime; | |
| − | |||
| + | CurrentTime = DateTime.FormatDuration(1000, "S,s"); | ||
| + | </syntaxhighlight> | ||
== See also == | == See also == | ||
[[GetTimeStamp]] <br/> | [[GetTimeStamp]] <br/> | ||
[[FormatDate]] | [[FormatDate]] | ||
Revision as of 08:30, 4 February 2015
Contents
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 = FormatDuration(IntegerTerm, StringTerm);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.
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 |
| Timestamp | Integer | Term | - | [0..1] | This property represents a duration in milliseconds to a string that is formatted according to the specified rules. |
| Pattern | String | Term | - | [0..1] | User-specified format for displaying the time. |
OTL Examples
String CurrentTime;
CurrentTime = DateTime.FormatDuration(1000, "S,s");