Function MomentToString(Format, unit, ReferenceDate, Elapsed)

MomentToString

The function MomentToString creates a string representation of a moment, that is calculated from a given amount of elapsed time since a specific reference date.

MomentToString(
     Format,                 ! (input) a string expression
     unit,                   ! (input) a time unit
     ReferenceDate,          ! (input) a string expression
     Elapsed                 ! (input) a numerical expression
     )

Arguments

Format

A string that holds the date and time format used in the returned string. Valid format strings are described in Format of Time Slots and Periods. Note that the format uses the local timezone by default. Thus the UTC timezone should be specified if the intent is to use the result as a reference date.

unit

The time unit that is used in the argument Elapsed.

ReferenceDate

A string that holds the begin date using the fixed format for date and time, see paragraph Reference date format of the Language Reference.

Elapsed

A numerical value of the time elapsed since ReferenceDate.

Return Value

The result of MomentToString is a string describing the corresponding moment according to Format.

Example

The code

sp_nextYear := MomentToString(
    Format        :  "%c%y-%m-%d",
    unit          :  day,
    ReferenceDate :  "2021-01-01",
    Elapsed       :  365[day]);
display sp_nextYear ;

gives the result:

sp_nextYear := "2022-01-01" ;

References