Sign in Join
FPDoc Onlineexperiment

WithinPastMinutes function

In unit DateUtils

Check whether two TDateTimes are only a number of minutes apart.

Declaration

pascal
function WithinPastMinutes(const ANow: TDateTime; 
 const AThen: TDateTime; const AMinutes: Int64)
: Boolean

Arguments

ANow

First moment in time.

AThen

Second moment in time.

AMinutes

Number of minutes to check.

Function result

True if ANow and Athen are only AMinutes apart, false otherwise.

Description

WithinPastMinutes compares the timestamps ANow and AThen and returns True if the difference between them is at most AMinutes minutes apart, or False if they are further apart.

Since this function uses the MinutesBetween function to calculate the difference in Minutes, this means that fractional minutes do not count, and the fractional part is simply dropped, so for two dates actually 2 and a half minutes apart, the result will also be True

See also

Example: ex52

pascal
Program Example52;

{ This program demonstrates the WithinPastMinutes function }

Uses SysUtils,DateUtils;

Procedure Test(ANow,AThen : TDateTime; AMinutes : Integer);

begin
 Write(DateTimeToStr(AThen),' and ',DateTimeToStr(ANow));
 Write(' are within ',AMinutes,' Minutes: ');
 Writeln(WithinPastMinutes(ANow,AThen,AMinutes));
end;

Var
  D1,D2 : TDateTime;

Begin
  D1:=Now;
  D2:=D1-(59*OneSecond);
  Test(D1,D2,1);
  D2:=D1-(61*OneSecond);
  Test(D1,D2,1);
  D2:=D1-(122*OneSecond);
  Test(D1,D2,1);
  D2:=D1-(306*OneSecond);
  Test(D1,D2,5);
  D2:=D1-(5.4*OneMinute);
  Test(D1,D2,5);
  D2:=D1-(2.5*OneMinute);
  Test(D1,D2,1);
  Test(D1,D2,2);
  Test(D1,D2,3);
End.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.