SEEBDateClass Methods [Top] |
|
Name |
Return Type |
Declaration |
Description |
|
SEEBDateClass |
|
SEEBDateClass () |
Construct
default SEEBDate value. Year = 1601, month = 1, day
= 1, hour = 0, minute = 0, second
= 0, Millisecond = 0. |
|
SEEBDateClass |
|
SEEBDateClass (ulong value) |
Construct SEEBDate value from 64 bit time / date stamp. |
|
SEEBDateClass |
|
SEEBDateClass (SEEBDateClass date) |
Copy
Constructor. |
|
SEEBDateClass |
|
SEEBDateClass (uint day , uint month, uint yr, uint hr, uint min, uint sec, uint ms = 0) |
Construct SEEBDate value from individual values. i.e. day, month,
year etc |
|
SEEBDateClass |
|
SEEBDateClass (DateClass date) |
Construct SEEBDate value from EnCase Date
Class. |
|
GetString |
|
Const GetString(EntryClass entry
= null, uint offset_options
= SEEBDateClass::DSTADJ, bool display_bias
= true, uint show_options
= SEEBDateClass::LONGDATE, bool
hour24 = true , bool display_ms
= false) |
Converts the
date to the string format. Arguments: Entry – EntryClass object or null. Offset_options – OffsetOptions
Enum value. Display_bias – display the bias i.e.
UTC(+10.00). Show_options – ShowOptions
Enum value. Hour24 –
24 hour time or not (12 hr) Display_ms – display milliseconds or not.
Time zone settings obtained from the volume the entry is on
– otherwise UTC( 0.00) Get String() = all default values. |
|
GetString |
|
const GetString (int bias_value, bool display_bias = true, uint show_options
= SEEBDateClass::LONGDATE, bool
hour24 = true, bool display_ms
= false) |
Converts the
date to the string format using specified bias. Arguments: Bias_value – bias entered manually. i.e -10 Display_bias – display the bias. Show_options – ShowOptions
Enum value. Hour24 –
24 hour time or not (12 hr) Display_ms – display milliseconds or not.
|
|
EnCaseString
|
String |
static EnCaseString(EntryClass
entry, uint offset_options
= SEEBDateClass::DSTADJ, bool display_bias
= true, uint show_options
= SEEBDateClass::LONGDATE, bool
hour24 = true , bool display_ms
= false) |
Converts the
date to the string format using the EnCase “Modify
time zone settings” to set the timezone for each
volume. Arguments: Entry – EntryClass object. Offset_options – OffsetOptions
Enum value. Display_bias – display the bias. Show_options – ShowOptions
Enum value. Hour24 –
24 hour time or not (12 hr) Display_ms – display milliseconds or not.
|
|
GetTimeZoneBias |
int |
static GetTimeZoneBias
() |
Returns the
local time zone offset in seconds |
|
Year |
int |
const Year () |
Year value in 4
digit format (1601..2038)
|
|
Month |
uint |
const Month () |
Month value
(1..12) |
|
Day |
uint |
const Day() |
Day value (
1...31 ) |
|
Hour |
uint |
const Hour () |
Hour value
(0..23) |
|
Minute |
uint |
const Minute () |
Minute value (0..59) |
|
Second |
uint |
const Second () |
Second value
(0..59) |
|
Millisecond |
uint |
const Millisecond() |
Millisecond
value (0…999) |
|
Ticks |
long |
const Ticks() |
Total number of
ticks |
|
DayOfWeek |
uint |
const DayOfWeek() |
Day of week
value ( 0=Sunday…6) |
|
DayOfWeekString |
String |
const DayOfWeekString() |
Day of week as
string. |
|
|
String |
const MonthString() |
Month value as
string (January…December) |
|
TotalSeconds |
ulong |
const TotalSeconds() |
Total seconds
from 1/1/1601 |
|
EqualTo |
bool |
EqualTo (SEEBDateClass value) |
Returns true if
== value. |
|
LessThan |
bool |
LessThan (SEEBDateClass value) |
Returns true
if < value |
|
GreaterThan |
bool |
GreaterThan(SEEBDateClass value) |
Returns true if
> value. |
|
IsLeapYear |
bool |
static IsLeapYear (uint year) |
Returns true if
year is a leap year. |
|
InRange |
bool |
static InRange (SEEBDateClass Value, SEEBDateClass
min, SEEBDateClass
max, , uint
accuracy_options = SEEBDateClass::SECOND) |
Value must be
between min and max, inclusive with accuracy = SECOND or MILLISECOND only.. |
|
IsValid |
bool |
const IsValid () |
Returns true if
the value is valid date. |
|
EntryDate |
SEEBDateClass |
EntryDate(EntryClass
entry, uint entrydate_options
= SEEBDateClass::CREATED) |
Converts the entry
date to SEEBDateClass. Arguments: Entry – EntryClass object to obtain dates from mft directly. Entrydate_options – EntryDateOptions
Enum.. |
|
Null |
void |
Null() |
Allows creation
of null date. 0/0/0 00:00:00. |
|
GetBias |
double |
static GetBias(EntryClass
entry = null) |
Returns entries
bias value. If null
entry - function returns default
time zone setting if only one timezone - or 0.. |
|
DstOffset |
int |
static DstOffset(EntryClass
entry = null) |
Returns the
entries DST offset.. |
|
ReadWinDate |
bool |
ReadWinDate (FileClass file) |
Construct SEEBDate value from 64 bit time / date stamp. Arguments: file – FileClass object.
|
|
ReadUnixDate |
bool |
ReadUnixDate (FileClass file) |
Construct SEEBDate value from 32 bit (C / Unix) time / date stamp. Arguments: file – FileClass object.
|
|
UnixDate |
double |
UnixDate(ulong value) |
Construct SEEBDate value from 32 bit (C / Unix) time / date stamp. Arguments: value |
|
DateToMilliseconds |
ulong |
static DateToMilliseconds(SEEBDateClass date) |
Covert a SEEBDate into total milliseconds for comparisons. |
|
Now |
void |
Now () |
Sets the value
to the current system date and time |
|
Set
|
void |
Set(uint day , uint month, uint yr, uint hr, uint min, uint sec, uint ms = 0) |
Sets the date
directly. |
|
Compare |
int |
Compare (const SEEBDateClass &Value, uint accuracy_options = SEEBDateClass::SECOND) |
Returns < 0
if value is lexically less than, 0 if equal, > 0 if greater. Arguments: Value – SEEBDateClass object. Accuracy_options – accuracy_options
enum value i.e. second, minute, millisecond.. |
|
TimeSpanString |
String |
static TimeSpanString (SEEBDateClass
date1, SEEBDateClass date2) |
The time span
between two dates in days + hours + minutes + seconds. |
|
TimeSpan |
ulong |
static TimeSpan (SEEBDateClass date1, SEEBDateClass date2) |
The time span
between two dates in seconds |
|