DateUtils.TryEncodeDayOfWeekInMonth Function

Calculates a TDateTime that represents a specified occurrence of a day of the week within a specified month and year.

Pascal

function TryEncodeDayOfWeekInMonth(const AYear: Word; const AMonth: Word; const ANthDayOfWeek: Word; const ADayOfWeek: Word; out AValue: TDateTime): Boolean;

C++

Boolean TryEncodeDayOfWeekInMonth(const Word AYear, const Word AMonth, const Word ANthDayOfWeek, const Word ADayOfWeek, TDateTime AValue);

File

DateUtils

Description

TryEncodeDayOfWeekInMonth returns a TDateTime for the date specified by the AYear, AMonth, ANthDayOfWeek, and ADayOfWeek parameters. The time portion of the return value is 0 (Midnight at the start of the specified day).

AYear is the year. It can be any value between 1 and 9999 (inclusive).

AMonth is the month. It can be any value between 1 and 12 (inclusive).

ANthDayOfWeek indicates the occurrence for the day of the week represented by ADayOfWeek. It can be any value between 1 and 5 (inclusive), as long as this value specifies a valid date. For example, if a month does not include 5 Mondays, setting ANthDayOfWeek to 5 and ADayOfWeek to 1 causes TryEncodeDayOfWeekInMonth to return F false.

ADayOfWeek is the day of the week, where 1 Monday and 7 is Sunday.

TryEncodeDayOfWeekInMonth returns true if AYear, AMonth, ANthDayOfWeek, and ADayOfWeek represent a valid date, and false if this combination does not correspond to a valid date.

Note: The definition for ADayOfWeek follows the ISO 8601 standard.

Tip: To make the ADayOfWeek value more readable, use the day of week constants.