[Overview][Constants][Procedures and functions][Index] Reference for unit 'dateutils' (#rtl)

Reference for unit 'dateutils': Procedures and functions

CompareDate

  

Compare 2 dates, disregarding the time of day

CompareDateTime

  

Compare 2 dates, taking into account the time of day

CompareTime

  

Compares two times of the day, disregarding the date part.

DateOf

  

Extract the date part from a DateTime indication.

DateTimeToDosDateTime

  

Convert TDateTime format to DOS date/time format

DateTimeToJulianDate

  

Converts a TDateTime value to a Julian date representation

DateTimeToMac

  

Convert a TDateTime timestamp to a Mac timestamp

DateTimeToModifiedJulianDate

  

Convert a TDateTime value to a modified Julian date representation

DateTimeToUnix

  

Convert a TDateTime value to Unix epoch time

DayOf

  

Extract the day (of month) part from a DateTime value

DayOfTheMonth

  

Extract the day (of month) part of a DateTime value

DayOfTheWeek

  

Extracts the day of the week from a DateTime value

DayOfTheYear

  

Extracts the day of the year from a TDateTime value

DaysBetween

  

Number of whole days between two DateTime values.

DaysInAMonth

  

Number of days in a month of a certain year.

DaysInAYear

  

Number of days in a particular year.

DaysInMonth

  

Return the number of days in the month in which a date occurs.

DaysInYear

  

Return the number of days in the year in which a date occurs.

DaySpan

  

Calculate the approximate number of days between two DateTime values.

DecodeDateDay

  

Decode a DateTime value in year and year of day.

DecodeDateMonthWeek

  

Decode a DateTime value in a month, week of month and day of week

DecodeDateTime

  

Decode a datetime value in a date and time value

DecodeDateWeek

  

Decode a DateTime value in a week of year and day of week.

DecodeDayOfWeekInMonth

  

Decode a DateTime value in year, month, day of week parts

DosDateTimeToDateTime

  

Convert DOS date/time format to TDateTime format

EncodeDateDay

  

Encodes a year and day of year to a DateTime value

EncodeDateMonthWeek

  

Encodes a year, month, week of month and day of week to a DateTime value

EncodeDateTime

  

Encodes a DateTime value from all its parts

EncodeDateWeek

  

Encode a TDateTime value from a year, week and day of week triplet

EncodeDayOfWeekInMonth

  

Encodes a year, month, week, day of week specification to a TDateTime value

EndOfADay

  

Calculates a DateTime value representing the end of a specified day

EndOfAMonth

  

Calculate a datetime value representing the last day of the indicated month

EndOfAWeek

  

Return the last moment of day of the week, given a year and a week in the year.

EndOfAYear

  

Calculate a DateTime value representing the last day of a year

EndOfTheDay

  

Calculate a datetime value that represents the end of a given day.

EndOfTheMonth

  

Calculate a DateTime value representing the last day of the month, given a day in that month.

EndOfTheWeek

  

Calculate a DateTime value which represents the end of a week, given a date in that week.

EndOfTheYear

  

Calculate a DateTime value representing the last day of a year, given a date in that year.

HourOf

  

Extract the hour part from a DateTime value.

HourOfTheDay

  

Calculate the hour of a given DateTime value

HourOfTheMonth

  

Calculate the number of hours passed since the start of the month.

HourOfTheWeek

  

Calculate the number of hours elapsed since the start of the week.

HourOfTheYear

  

Calculate the number of hours passed since the start of the year.

HoursBetween

  

Calculate the number of whole hours between two DateTime values.

HourSpan

  

Calculate the approximate number of hours between two DateTime values.

IncDay

  

Increase a DateTime value with a number of days.

IncHour

  

Increase a DateTime value with a number of hours.

IncMilliSecond

  

Increase a DateTime value with a number of milliseconds.

IncMinute

  

Increase a DateTime value with a number of minutes.

IncSecond

  

Increase a DateTime value with a number of seconds.

IncWeek

  

Increase a DateTime value with a number of weeks.

IncYear

  

Increase a DateTime value with a number of years.

InvalidDateDayError

  

Raise an EConvertError exception when a day is not a valid day of a year.

InvalidDateMonthWeekError

  

Raise an EConvertError exception when a Year,Month,WeekOfMonth,DayofWeek is invalid.

InvalidDateTimeError

  

Raise an EConvertError about an invalid date-time specification.

InvalidDateWeekError

  

Raise an EConvertError with an invalid Year, WeekOfyear and DayOfWeek specification

InvalidDayOfWeekInMonthError

  

Raise an EConvertError exception when a Year,Month,NthDayofWeek,DayofWeek is invalid.

IsInLeapYear

  

Determine whether a date is in a leap year.

IsPM

  

Determine whether a time is PM or AM.

IsSameDay

  

Check if two date/time indications are the same day.

IsToday

  

Check whether a given date is today.

IsValidDate

  

Check whether a set of values is a valid date indication.

IsValidDateDay

  

Check whether a given year/day of year combination is a valid date.

IsValidDateMonthWeek

  

Check whether a given year/month/week/day of the week combination is a valid day

IsValidDateTime

  

Check whether a set of values is a valid date and time indication.

IsValidDateWeek

  

Check whether a given year/week/day of the week combination is a valid day.

IsValidTime

  

Check whether a set of values is a valid time indication.

JulianDateToDateTime

  

Convert a Julian date representation to a TDateTime value.

MacTimeStampToUnix

  

Convert a Mac timestamp to a Unix timestamp

MacToDateTime

  

Convert a Mac timestamp to a TDateTime timestamp

MilliSecondOf

  

Extract the millisecond part from a DateTime value.

MilliSecondOfTheDay

  

Calculate the number of milliseconds elapsed since the start of the day

MilliSecondOfTheHour

  

Calculate the number of milliseconds elapsed since the start of the hour

MilliSecondOfTheMinute

  

Calculate the number of milliseconds elapsed since the start of the minute

MilliSecondOfTheMonth

  

Calculate number of milliseconds elapsed since the start of the month.

MilliSecondOfTheSecond

  

Calculate the number of milliseconds elapsed since the start of the second

MilliSecondOfTheWeek

  

Calculate the number of milliseconds elapsed since the start of the week

MilliSecondOfTheYear

  

Calculate the number of milliseconds elapsed since the start of the year.

MilliSecondsBetween

  

Calculate the number of whole milliseconds between two DateTime values.

MilliSecondSpan

  

Calculate the approximate number of milliseconds between two DateTime values.

MinuteOf

  

Extract the minute part from a DateTime value.

MinuteOfTheDay

  

Calculate the number of minutes elapsed since the start of the day

MinuteOfTheHour

  

Calculate the number of minutes elapsed since the start of the hour

MinuteOfTheMonth

  

Calculate number of minutes elapsed since the start of the month.

MinuteOfTheWeek

  

Calculate the number of minutes elapsed since the start of the week

MinuteOfTheYear

  

Calculate the number of minutes elapsed since the start of the year

MinutesBetween

  

Calculate the number of whole minutes between two DateTime values.

MinuteSpan

  

Calculate the approximate number of minutes between two DateTime values.

ModifiedJulianDateToDateTime

  

Convert a modified Julian date representation to a TDateTime value.

MonthOf

  

Extract the month from a given date.

MonthOfTheYear

  

Extract the month of a DateTime indication.

MonthsBetween

  

Calculate the number of whole months between two DateTime values

MonthSpan

  

Calculate the approximate number of months between two DateTime values.

NthDayOfWeek

  

Calculate which occurrence of weekday in the month a given day represents

PreviousDayOfWeek

  

Given a day of the week, return the previous day of the week.

RecodeDate

  

Replace date part of a TDateTime value with another date.

RecodeDateTime

  

Replace selected parts of a TDateTime value with other values

RecodeDay

  

Replace day part of a TDateTime value with another day.

RecodeHour

  

Replace hours part of a TDateTime value with another hour.

RecodeMilliSecond

  

Replace milliseconds part of a TDateTime value with another millisecond.

RecodeMinute

  

Replace minutse part of a TDateTime value with another minute.

RecodeMonth

  

Replace month part of a TDateTime value with another month.

RecodeSecond

  

Replace seconds part of a TDateTime value with another second.

RecodeTime

  

Replace time part of a TDateTime value with another time.

RecodeYear

  

Replace year part of a TDateTime value with another year.

SameDate

  

Check whether two TDateTime values have the same date part.

SameDateTime

  

Check whether two TDateTime values have the same date and time parts.

SameTime

  

Check whether two TDateTime values have the same time part.

ScanDateTime

  

Scans a string for a DateTime pattern and returns the date/time

SecondOf

  

Extract the second part from a DateTime value.

SecondOfTheDay

  

Calculate the number of seconds elapsed since the start of the day

SecondOfTheHour

  

Calculate the number of seconds elapsed since the start of the hour

SecondOfTheMinute

  

Calculate the number of seconds elapsed since the start of the minute

SecondOfTheMonth

  

Calculate number of seconds elapsed since the start of the month.

SecondOfTheWeek

  

Calculate the number of seconds elapsed since the start of the week

SecondOfTheYear

  

Calculate the number of seconds elapsed since the start of the year.

SecondsBetween

  

Calculate the number of whole seconds between two DateTime values.

SecondSpan

  

Calculate the approximate number of seconds between two DateTime values.

StartOfADay

  

Return the start of a day as a DateTime value, given a day indication

StartOfAMonth

  

Return first date of month, given a year/month pair.

StartOfAWeek

  

Return a day of the week, given a year, week and day in the week.

StartOfAYear

  

Return the first day of a given year.

StartOfTheDay

  

Calculate the start of the day as a DateTime value, given a moment in the day.

StartOfTheMonth

  

Calculate the first day of the month, given a date in that month.

StartOfTheWeek

  

Return the first day of the week, given a date.

StartOfTheYear

  

Return the first day of the year, given a date in this year.

TimeOf

  

Extract the time part from a DateTime indication.

Today

  

Return the current date

Tomorrow

  

Return the next day

TryEncodeDateDay

  

Encode a year and day of year to a TDateTime value

TryEncodeDateMonthWeek

  

Encode a year, month, week of month and day of week to a TDateTime value

TryEncodeDateTime

  

Encode a Year, Month, Day, Hour, minute, seconds, milliseconds tuplet to a TDateTime value

TryEncodeDateWeek

  

Encode a year, week and day of week triplet to a TDateTime value

TryEncodeDayOfWeekInMonth

  

Encode a year, month, week, day of week triplet to a TDateTime value

TryJulianDateToDateTime

  

Convert a Julian date representation to a TDateTime value.

TryModifiedJulianDateToDateTime

  

Convert a modified Julian date representation to a TDateTime value.

TryRecodeDateTime

  

Replace selected parts of a TDateTime value with other values

UnixTimeStampToMac

  

Convert Unix Timestamp to a Mac Timestamp

UnixToDateTime

  

Convert Unix epoch time to a TDateTime value

WeekOf

  

Extract week (of the year) from a given date.

WeekOfTheMonth

  

Extract the week of the month (and optionally month and year) from a DateTime value

WeekOfTheYear

  

Extract the week of the year (and optionally year) of a DateTime indication.

WeeksBetween

  

Calculate the number of whole weeks between two DateTime values

WeeksInAYear

  

Return the number of weeks in a given year

WeeksInYear

  

return the number of weeks in the year, given a date

WeekSpan

  

Calculate the approximate number of weeks between two DateTime values.

WithinPastDays

  

Check whether two datetimes are only a number of days apart

WithinPastHours

  

Check whether two datetimes are only a number of hours apart

WithinPastMilliSeconds

  

Check whether two datetimes are only a number of milliseconds apart

WithinPastMinutes

  

Check whether two datetimes are only a number of minutes apart

WithinPastMonths

  

Check whether two datetimes are only a number of months apart

WithinPastSeconds

  

Check whether two datetimes are only a number of seconds apart

WithinPastWeeks

  

Check whether two datetimes are only a number of weeks apart

WithinPastYears

  

Check whether two datetimes are only a number of years apart

YearOf

  

Extract the year from a given date.

YearsBetween

  

Calculate the number of whole years between two DateTime values

YearSpan

  

Calculate the approximate number of years between two DateTime values.

Yesterday

  

Return the previous day.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.