intvName Function

Returns the name of the interval that is the specified number of intervals ahead of the specified date.


str intvName(date input_date, int col, enum func)

Parameter

Description

input_date

A date in the first interval.

col

The number of intervals ahead of date specified by the input_date. parameter.

func

An intvScale enumeration value.

The name of the interval.

For example, if the func parameter is the IntvScale::WeekDay enumeration value, this method will return the name of the week day. If the func parameter is the IntvScale::Week enumeration value, this method will return a string that contains the number of the week. For a description of the func parameter, see intvMax.

static void intvNameExample(Args _args)
{
    date refDate = 26\7\2010;
    str name;
    ;
    
    name = intvName(refDate, 3,  intvScale::WeekDay);
    Global::info(strfmt("%1 is the output, which indicates the day of the week 3 days after 26\\7\\2010.", name));
}
/**** Infolog display.
Message (09:56:55 am)
Thu is the output, which indicates the day of the week 3 days after 26\7\2010.
****/

Community Additions

ADD
Show: