threadsafelog DateTimeFormat property
Return to Introduction  Previous page  Next page
Applies to
acThreadSafeLog component.  

Declaration
property DateTimeFormat: String// 'dd/mm/yyyy hh:nn:ss' by default  

Description
The DateTimeFormat property specifies the format of the date-and-time value which can be automatically stored to the log as prefix of each line, if putTimeStamp Option is True.  
 
When the component put current date and time to the log, it uses standard FormatDateTime function from SysUtils unit. The following format specifiers are supported:  
SpecifierDisplays  
cDisplays the date using the format given by the ShortDateFormat global variable, followed by the time using the format given by the LongTimeFormat global variable. The time is not displayed if the fractional part of the DateTime value is zero.  
dDisplays the day as a number without a leading zero (1-31).  
ddDisplays the day as a number with a leading zero (01-31).  
dddDisplays the day as an abbreviation (Sun-Sat) using the strings given by the ShortDayNames global variable.  
ddddDisplays the day as a full name (Sunday-Saturday) using the strings given by the LongDayNames global variable.  
dddddDisplays the date using the format given by the ShortDateFormat global variable.  
ddddddDisplays the date using the format given by the LongDateFormat global variable.  
mDisplays the month as a number without a leading zero (1-12). If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.  
mmDisplays the month as a number with a leading zero (01-12). If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.  
mmmDisplays the month as an abbreviation (Jan-Dec) using the strings given by the ShortMonthNames global variable.  
mmmmDisplays the month as a full name (January-December) using the strings given by the LongMonthNames global variable.  
yyDisplays the year as a two-digit number (00-99).  
yyyyDisplays the year as a four-digit number (0000-9999).  
hDisplays the hour without a leading zero (0-23).  
hhDisplays the hour with a leading zero (00-23).  
nDisplays the minute without a leading zero (0-59).  
nnDisplays the minute with a leading zero (00-59).  
sDisplays the second without a leading zero (0-59).  
ssDisplays the second with a leading zero (00-59).  
tDisplays the time using the format given by the ShortTimeFormat global variable.  
ttDisplays the time using the format given by the LongTimeFormat global variable.  
am/pmUses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour before noon, and 'pm' for any hour after noon. The am/pm specifier can use lower, upper, or mixed case, and the result is displayed accordingly.  
a/pUses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour before noon, and 'p' for any hour after noon. The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly.  
ampmUses the 12-hour clock for the preceding h or hh specifier, and displays the contents of the TimeAMString global variable for any hour before noon, and the contents of the TimePMString global variable for any hour after noon.  
/Displays the date separator character given by the DateSeparator global variable.  
:Displays the time separator character given by the TimeSeparator global variable.  
'xx'/"xx"Characters enclosed in single or double quotes are displayed as-is, and do not affect formatting.  
 
Format specifiers may be written in upper case as well as in lower case letters--both produce the same result.  
If the string given by the Format parameter is empty, the date and time value is formatted as if a 'c' format specifier had been given.  
 
tip This property only take effect if you set putTimeStamp option to True in the Options property. Alternatively, if you don't want to use standard date-time convertion functions, you can write your own OnCustomPrefix event handler, to specify the text which will appear before each line of the log file.  

See also
Options property and OnCustomPrefix event.