TryRecodeDateTime function
Replace selected parts of a
TDateTime value with other values.
Declaration
function TryRecodeDateTime(const AValue: TDateTime; const AYear: Word;
const AMonth: Word; const ADay: Word;
const AHour: Word; const AMinute: Word;
const ASecond: Word;
const AMilliSecond: Word;
out AResult: TDateTime): BooleanArguments
AValue | Date/time to recode. |
AYear | New value for year part. |
AMonth | New value for month part. |
ADay | New value for day part. |
AHour | New value for hour part. |
AMinute | New value for minute part. |
ASecond | New value for second part. |
AMilliSecond | New value for millisecond part. |
AResult | Recoded
|
Function result
True if the recoding was successful,
False if not.Description
TryRecodeDateTime replaces selected parts of the timestamp
AValue
with the date/time values specified in
AYear,
AMonth,
ADay,
AHour,
AMinute,
ASecond and
AMilliSecond. If any of these values
equals the predefined constant
RecodeLeaveFieldAsIs, then
the corresponding part of the date/time stamp is left untouched.
The resulting date/time is returned in AValue.
The function returns True if the encoding was successful. It
returns False if one of the values AYear, AMonth,
ADay, AHour, AMinute, ASecondAMilliSecond is not within a valid range.
See also
- RecodeYear
- RecodeMonth
- RecodeDay
- RecodeHour
- RecodeMinute
- RecodeSecond
- RecodeMilliSecond
- RecodeDate
- RecodeTime
- RecodeDateTime
Example: ex97
Program Example97;
{ This program demonstrates the TryRecodeDateTime function }
Uses SysUtils,DateUtils;
Const
Fmt = 'dddd dd mmmm yyyy hh:nn:ss';
Var
S : AnsiString;
D : TDateTime ;
Begin
If TryRecodeDateTime(Now,2000,2,RecodeLeaveFieldAsIs,0,0,0,0,D) then
begin
S:=FormatDateTime(Fmt,D);
Writeln('This moment in februari 2000 : ',S);
end
else
Writeln('This moment did/does not exist in februari 2000');
End.An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.