VB.NET Language in a Nutshell, Second Edition

Name

FormatDateTime Function

Class

Microsoft.VisualBasic.Strings

Syntax

FormatDateTime(expression[,dateformat])

expression (required; date)

Date variable or literal date

dateformat (optional; DateFormat enum)

Defines the format of the date to return

Return Value

String representing the formatted date or time

Description

Formats a date or time expression based on the computer’s regional settings

Rules at a Glance

• The Dateformat enum is:

  DateFormat.GeneralDate 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.

  DateFormat.LongDate Value: 1

  Uses the long-date format specified in the client computer’s regional settings.

  DateFormat.ShortDate Value: 2

  Uses the short-date format specified in the client computer’s regional settings.

  DateFormat.LongTime Value: 3

  Uses the time format specified in the computer’s regional settings.

  DateFormat.ShortTime Value: 4

  Uses a 24-hour format (hh:mm).

• The default date format is GeneralDate.

Programming Tips and Gotchas

• Remember that date and time formats obtained from the client computer are based upon the client computer’s regional settings. It is not uncommon for a single application to be used internationally, so date formats can vary widely. Not only that, but you can never be sure that a user has not modified the regional settings on her computer. In short, never take a date coming in from a client machine for granted; ideally, ...