Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter FiveGeneral Functions (continued)

DurationToString Function

Overview

The DurationToString function converts an array or duration values to a duration string.

Syntax/Parameters

Syntax

string = DurationToString ( string list[], [string zero_default] );

string = DurationToString ( int list[], [string zero_default] );

string = DurationToString ( float list[], [string zero_default] );

Parameters

list

A string, int or float array containing keyed values for one or more duration segments.

zero_default

An optional string expressing the default value if the resulting duration string is empty.

Return Value

Returns a string with the ISO/XML duration or empty value on failure. Use the GetLastError function to retrieve error information.

Remarks

The DurationToString function does not perform any duration math or logic. Rather is creates a duration string based on the following optional key names: “years”, “months”, “days”, “weeks”, “hours”, “minutes”, “seconds” and “sign”. The zero_default parameter string defines a return value if no keyed values are set.

Related Functions 

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic