toDuration toDuration

Converts an argument value to a duration. For more information on data types, refer to this page.

Category

Conversion

Function syntax

toDuration(<parameter>)

Parameters

If string expression: formats accepted are based on the ISO-8601 duration format PnDTnHnMn.nS with days considered to be exactly 24 hours.

The string starts with an optional sign, denoted by the ASCII negative or positive symbol. If negative, the whole period is negated. The ASCII letter “P” is next in upper or lower case. There are then four sections, each consisting of a number and a suffix. The sections have suffixes in ASCII of “D”, “H”, “M” and “S” for days, hours, minutes and seconds, accepted in upper or lower case. The suffixes must occur in order. The ASCII letter “T” must occur before the first occurrence, if any, of an hour, minute or second section. At least one of the four sections must be present, and if “T” is present there must be at least one section after the “T”. The number part of each section must consist of one or more ASCII digits. The number may be prefixed by the ASCII negative or positive symbol. The number of days, hours and minutes must parse to along. The number of seconds must parse to along with optional fraction. The decimal point may be either a dot or a comma. The fractional part may have from zero to 9 digits.

Signatures and returned type

toDuration(<string>)

toDuration(<integer>)

Returns a duration.

Examples

toDuration("PT10H")

Returns duration of 10 hours.

toDuration("PT4S")

Returns duration of 4s.

toDuration(4000)

Returns duration of 4s.