windows_programming_notes.nbk: Home | Index | Next Page: GetFileType | Previous Page: GetFileAttributesEx

 GetFileTime

Retrieves the date and time that a file or directory was created, last accessed, and last modified.

Syntax

    BOOL WINAPI GetFileTime(
      __in       HANDLE hFile,
      __out_opt  LPFILETIME lpCreationTime,
      __out_opt  LPFILETIME lpLastAccessTime,
      __out_opt  LPFILETIME lpLastWriteTime
    );

Parameters

• hFile
  A handle to the file or directory for which dates and times are to be retrieved. The handle must have been created using the CreateFile function with the GENERIC_READ access right. For more information, see File Security and Access Rights.
• lpCreationTime
  A pointer to a FILETIME structure to receive the date and time the file or directory was created. This parameter can be NULL if the application does not require this information.
• lpLastAccessTime
  A pointer to a FILETIME structure to receive the date and time the file or directory was last accessed. The last access time includes the last time the file or directory was written to, read from, or, in the case of executable files, run. This parameter can be NULL if the application does not require this information.
• lpLastWriteTime
  A pointer to a FILETIME structure to receive the date and time the file or directory was last written to, truncated, or overwritten (for example, with WriteFile or SetEndOfFile). This date and time is not updated when file attributes or security descriptors are changed. This parameter can be NULL if the application does not require this information.

Return Value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

Not all file systems can record creation and last access times and not all file systems record them in the same manner. For example, on FAT, create time has a resolution of 10 milliseconds, write time has a resolution of 2 seconds, and access time has a resolution of 1 day (really, the access date). Therefore, the GetFileTime function may not return the same file time information set using SetFileTime. NTFS delays updates to the last access time for a file by up to one hour after the last access.

For more information, see File Times.

If you rename or delete a file, then restore it shortly thereafter, Windows searches the cache for file information to restore. Cached information includes its short/long name pair and creation time.

Requirements

• Client Requires Windows Vista, Windows XP, or Windows 2000 Professional.
• Server Requires Windows Server 2008, Windows Server 2003, or Windows 2000 Server.
• Header Declared in Winbase.h; include Windows.h.
• Library Use Kernel32.lib.
• DLL Requires Kernel32.dll.

windows_programming_notes.nbk: Home | Index | Next Page: GetFileType | Previous Page: GetFileAttributesEx

Notebook exported on Monday, 7 July 2008, 18:56:50 PM Eastern Daylight Time