LocalFileTime Manual

Table of Contents

• About
• Access
• Allocation/Deallocation
• Use
• Attributes
• Miscellaneous
• Further Reading

About

A simple class to store file dates and times (e.g. file creation date and time).

Access

Usually one is provided with a LocalFileTime, when browsing files via BrowseFiles class, see also BrowseFiles Manual.

• BrowseFiles::GetFileTime(): Gets a time for the current file or directory.

It is also possible to directly query or set a time from/to a file.

• GeGetFileTime(): Gets a file time for the given mode.
• GeSetFileTime(): Sets the file time for the given mode.
  • Parameter "mode", file time modes (GE_FILETIME):
    • GE_FILETIME_CREATED: File time created
    • GE_FILETIME_MODIFIED: File time modified
    • GE_FILETIME_ACCESS: File time accessed

For comparisons it might be handy to get the current time as LocalFileTime:

• GeGetCurrentTime(): Gets the current time.

Allocation/Deallocation

A LocalFileTime can simply be declared, no special allocation is needed. Yet, it is recommended to initialize a new LocalFileTime instance via its LocalFileTime::Init() function to avoid problems with uninitialized member variables.

Use

Functions:

• LocalFileTime::Init(): Initializes the file time to a possibly invalid but deterministic state (0000-00-00 00:00:00).
• LocalFileTime::Compare(): Compare the two file times.
• LocalFileTime::operator==(): Equality operator.
• LocalFileTime::operator!=(): Inequality operator.
• LocalFileTime::operator>(): Greater than operator.
• LocalFileTime::operator<(): Less than operator.
• LocalFileTime::operator>=(): Greater than or equal operator.
• LocalFileTime::operator<=(): Less than or equal operator.

Attributes

Attributes:

• LocalFileTime::year: Year (e.g. 2005 A.D. = 2005)
• LocalFileTime::month: Month (e.g. September = 9)
• LocalFileTime::day: Day (Between 1 and 31, e.g. 30th = 30)
• LocalFileTime::hour: Hour (Between 0 and 23, 4pm = 16)
• LocalFileTime::minute: Minute (Between 0 and 59)
• LocalFileTime::second: Second (Between 0 and 59)

Miscellaneous

A LocalFileTime can be easily converted into a String:

• DateToString(): Converts the value of a LocalFileTime into a string.

Further Reading

• Filename Manual
• BrowseFiles Manual