Ticket #2516: FileGetTime.txt

File FileGetTime.txt, 1.2 KB (added by mlipok, 11 years ago)
Line 
1###Function###
2FileGetTime
3
4###Description###
5Returns the time and date information for a file.
6
7###Syntax###
8FileGetTime ( "filename" [, option = 0 [, format = 0]] )
9
10
11###Parameters###
12@@ParamTable@@
13filename
14        The path to the file or directory to check.
15option
16        [optional] Flag to indicate which timestamp
17                $FT_MODIFIED (0) = Last modified (default)
18                $FT_CREATED (1) = Created
19                $FT_ACCESSED (2) = Last accessed
20        Constants are defined in FileConstants.au3
21format
22        [optional] to specify type of return
23                0 = return an array (default)
24                1 = return a string YYYYMMDDHHMMSS
25@@End@@
26
27###ReturnValue###
28@@ReturnTable@@
29Success:        an array or string that contains the file time information.  See Remarks.
30Failure:        sets the @error flag to non-zero.
31@@End@@
32
33
34###Remarks###
35The array is a single dimension array containing six elements:
36        $aArray[0] = year  (four digits)
37        $aArray[1] = month (range 01 - 12)
38        $aArray[2] = day   (range 01 - 31)
39        $aArray[3] = hour  (range 00 - 23)
40        $aArray[4] = min   (range 00 - 59)
41        $aArray[5] = sec   (range 00 - 59)
42Notice that return values are zero-padded.
43
44
45###Related###
46FileGetSize, FileGetAttrib, FileGetVersion, FileSetTime, FileSetAttrib
47
48
49###Example###
50@@IncludeExample@@