Year (FPScript)
Determines the value for the year of one or more calendar time values.
Syntax
Year(CalendarTime)
or
Year(CalendarTime, Timezone)
The syntax of the Year function consists of the following parts:
Part |
Description |
|---|---|
CalendarTime |
Is the calendar time value from which the value for the year is to be extracted. Permitted data structures are scalar value, data series und data matrix. All real data types are permitted. If the argument is a list, then the function is executed for each element of the list and the result is also a list. |
Timezone |
Is the timezone for which the result should be determined, as a time offset from Coordinated Universal Time (UTC) in hours. If you omit the argument, the result will be determined in local time. Permitted data structures are scalar value. Supported data types are 16-bit integer, 32-bit integer, 64-bit integer, 32-bit floating point, 64-bit floating point und time span. If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated. |
Remarks
The data type of the result is always 64-bit floating point.
The structure of the result corresponds to that of the argument CalendarTime. The calculation is done element-by-element where appropriate.
If the argument does not represent a valid calendar time, then a void floating point value is output.
Available in
FlexPro View, Basic, Professional, Developer Suite
Examples
Year('3/2/04') |
Results in 2004. |