Difference between revisions of "Extensions.DateTime.FormatDuration"
Jump to navigation
Jump to search
| Line 10: | Line 10: | ||
== Description == | == 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. | 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 [[Core.DataTypes.ComplexDataType.OutOfBoundsException|OutOfBoundsException]] exception will be thrown. | ||
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | A formatted time.}} | {{TermReturnValue| [[Core.DataTypes.SimpleDataType.String|String]] | A formatted time.}} | ||
Revision as of 03:58, 26 September 2018
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.
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 |
| 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");