Name
FormatDateTime Function
Syntax
FormatDateTime(date
[,format
])
-
date
Use: Required
Data Subtype: Date or String
Any expression that can be evaluated as a date.
-
format
Use: Optional
Data Subtype: Long
Defines the format; see the list of values in “Rules at a Glance.”
Return Value
String
Description
Formats a date or time expression based on the computer’s regional settings.
Rules at a Glance
The intrinsic constants to use for the format argument are:
-
vbGeneralDate
Value: 0
Displays a date and/or time. If there is a date part, displays it as a short date. If there is a time part, displays it as a long time. If present, both parts are displayed.
-
VbLongDate
Value: 1
Uses the long date format specified in the client computer’s regional settings.
-
VbShortDate
Value: 2
Uses the short date format specified in the client computer’s regional settings.
-
VbLongTime
Value: 3
Uses the time format specified in the computer’s regional settings.
-
VbShortTime
Value: 4
Uses a 24-hour format (hh:mm).
-
The default date format is
vbGeneralDate
(0
).These constants are all defined in the VBScript library and hence are an intrinsic part of the language.
Programming Tips & Gotchas
Remember that date and time formats obtained from the client computer are based on the client computer’s regional settings. It’s not uncommon for a single application to be used internationally, so that date formats can vary widely. Not only that, but you can never be sure that a user has not modified the regional settings on a computer. In short, ...
Get VBScript in a Nutshell now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.