DateUtils.TryEncodeDayOfWeekInMonth
Contents |
Delphi Information
From DateUtils.pas
function TryEncodeDayOfWeekInMonth(const AYear: Word; const AMonth: Word; const ANthDayOfWeek: Word; const ADayOfWeek: Word; out AValue: TDateTime): Boolean;
Unit: DateUtils
Type: function
Visibility: public
C++ Information
From DateUtils.hpp
bool __fastcall TryEncodeDayOfWeekInMonth(unsigned short AYear, unsigned short AMonth, unsigned short ANthDayOfWeek, unsigned short ADayOfWeek, System::TDateTime & AValue);
Unit: DateUtils
Type: function
Description
Calculates a TDateTime that represents a specified occurrence of a day of the week within a specified month and year.
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 from 1 through 9999 (inclusive).
AMonth is the month. It can be any value from 1 through 12 (inclusive).
ANthDayOfWeek indicates the occurrence for the day of the week represented by ADayOfWeek. It can be any value from 1 through 5 (inclusive), as long as this value specifies a valid date. For example, if a month does not include five Mondays, setting ANthDayOfWeek to 5 and ADayOfWeek to 1 causes TryEncodeDayOfWeekInMonth to return False.
ADayOfWeek is the day of the week, where 1 is 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.
See Also
Code Samples