GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Five — General Functions (continued)

DurationToTimeComponents Function

Overview

The DurationToTimeComponents function converts a formatted duration string and returns a list of time components. For example, “P1M” returns one month.

Syntax/Parameters

Syntax

int [] = DurationToTimeComponents ( string duration );

Parameters

duration

A string containing an XML/ISO-8601 formatted duration string.

Return Value

Returns an int array containing the time components or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

Unlike DurationToComponents, this function converts the specified items into average values and then fills a standard time list using Windows system time values.

The returned array elements are named as follows:

	Key Name		Description
	Negative		Present and set to non-zero if the string was preceded by a dash (‘-’) symbol.
	Year		Year value.
	Month		Month value.
	DayOfWeek		Day of week value. The first day is 0, or Sunday, while the last is 6, or Saturday. Note this is only valid when getting components from a date-time qword value as opposed to a date string. There is no way of differentiating an empty index from Sunday. The days are defined in the SDK. DOW_SUNDAY     —  0 DOW_MONDAY     —  1 DOW_TUESDAY    —  2 DOW_WEDNESDAY  —  3 DOW_THURSDAY   —  4 DOW_FRIDAY     —  5 DOW_SATURDAY   —  6
	Day		Day of month value.
	Hour		Hour value. Value will be zero if not included in the incoming value parameter.
	Minute		Minute value. Value will be zero if not included the incoming value parameter.
	Second		Second value. Value will be zero if not included the incoming value parameter.
	Milliseconds		Milliseconds value. Value will be zero if not included the incoming value parameter.

 

If a value is not specified, the key name will not be present in the list.

To set the values in the array, simple math functions are performed using average values, for example not all months are 30 days. Since there is no reference date, averages must be employed.

Related Functions 

AddDays — Adds (or subtracts) days to an ISO-8601 formatted date and returns an ISO-8601 date.

AddDuration — Adds an ISO duration code to an ISO date-time string.

DurationToDays — Parses an ISO Duration into components and returns number of days.

DurationToString — Converts an array of duration items to an ISO/XML duration string.

DurationToTime

DurationToTimeComponents — Converts an ISO Duration to Standard Windows Time Components.

StringToDate — Converts a string to file time format as a qword.

StringToDuration — Interprets a natural language string and converts to an XML duration.

SubtractDuration — Subtracts an ISO duration code from an ISO date-time string.

SubtractDates — Subtracts ISO-8601 style date ‘b’ from ‘a’ and returns the number of days.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.