Difference between revisions of "Extensions.DateTime.FormatDuration"
Jump to navigation
Jump to search
| Line 20: | Line 20: | ||
== Examples == | == Examples == | ||
| + | A duration of {{FontColor|blue||203443}} milliseconds ( {{FontColor|blue||3 minutes 23 seconds and 443 milliseconds}} ), a pattern such as "{{FontColor|blue||'It takes'}} {{FontColor|red||m}} {{FontColor|blue||'minutes and'}} {{FontColor|red||s}} {{FontColor|blue||'.seconds'}} "generates the following formatted output: {{FontColor|blue||"It takes 3 minutes and 23 seconds."}} <br/> | ||
| + | |||
| + | If there is no pattern specified, the output is after the fashion of ISO 8601 ( {{FontColor|blue||'P'yyyy-MM-dd'T'HH: mm: ss' . 'SSS}} ) " {{FontColor|blue||P0000-00-00T00: 03:23.443}}", where "{{FontColor|blue||P}}" designator for the duration and "{{FontColor|blue||T}}" is the designator for time. | ||
== See also == | == See also == | ||
Revision as of 03:33, 12 July 2014
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 |
Pseudo-Code Syntax
String duration = FormatDuration(Timestamp, <<pattern>>);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.
Properties
| Name | Data Type | Class | Default | Cardinality | Description |
| Duration | String | Variable | - | [0..1] | A formatted time. |
| 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. |
Examples
A duration of 203443 milliseconds ( 3 minutes 23 seconds and 443 milliseconds ), a pattern such as " 'It takes' m 'minutes and' s '.seconds' "generates the following formatted output: "It takes 3 minutes and 23 seconds."
If there is no pattern specified, the output is after the fashion of ISO 8601 ( 'P'yyyy-MM-dd'T'HH: mm: ss' . 'SSS ) " P0000-00-00T00: 03:23.443 ", where " P " designator for the duration and " T " is the designator for time.
