yearEnd#

swordfish.function.yearEnd()#

Return the last day of the year that X belongs to and that ends in the month of endingMonth. If parameter offset is specified, the result is updated every n years. The parameters offset and n must be specified together, and offset takes effect only when n > 1.

Parameters:

  • X (Constant) – A scalar/vector of data type DATE, DATEHOUR, DATETIME, TIMESTAMP or NANOTIMESTAMP.

  • endingMonth (Constant, optional) – An integer between 1 and 12 indicating a month, by default DFLT.

  • offset (Constant, optional) – A scalar of the same data type as X, by default DFLT. It must be no greater than the minimum value of X.

  • n (Constant, optional) – A positive integer, by default DFLT

On this page