Функция FormatDateTime (Visual Basic)

Статья
11/05/2008

Обновлен: Ноябрь 2007

Возвращает строковое выражение, представляющее значение даты и времени.

Function FormatDateTime(
   ByVal Expression As DateTime,
   Optional ByVal NamedFormat As DateFormat = DateFormat.GeneralDate
) As String

Параметры

Expression
Обязательный. Выражение Date, подлежащее форматированию.
NamedFormat
Необязательный. Числовое значение, указывающее используемый формат даты и времени. Если опущен, используется DateFormat.GeneralDate.

Параметры

Аргумент NamedFormat может принимать следующие значения.

Константа	Описание
DateFormat.GeneralDate	Отображается дата и (или) время. Отображается часть даты в виде краткого формата даты. Если предусмотрено значение времени, время отображается в полном формате. Если указано, отображаются обе части.
DateFormat.LongDate	Отображается дата в полном формате, который определяется установленными на компьютере региональными настройками.
DateFormat.ShortDate	Отображается дата в кратком формате, который определяется установленными на компьютере региональными настройками.
DateFormat.LongTime	Отображается время в формате, который определяется установленными на компьютере региональными настройками.
DateFormat.ShortTime	Отображается время в 24-часовом формате (чч:мм).

Исключения

Тип исключения	Номер ошибки	Условие
ArgumentException	5	Параметр NamedFormat недопустим.

См. столбец "Номер ошибки", если выполняется обновление приложений Visual Basic 6.0, в которых используется неструктурированная обработка ошибок. (Можно сравнить номер ошибки с Свойство Number (объект Err).) Однако, по возможности, следует изменить такую систему управления ошибками на Обзор структурной обработки исключений в Visual Basic.

Заметки

Тип данных Date всегда включает и дату, и время. При преобразовании типов в Visual Basic нейтральным значением даты считается 1/1/1 (1 января 1 года), а нейтральным значением времени — 00:00:00 (полночь). Если форматировать значение Date в виде строки даты и времени, функция FormatDateTime не включает нейтральные значения в результирующую строку. Например, при преобразовании значения #1/1/0001 9:30:00# в строку будет возвращен результат "9:30:00 AM"; информация о дате отбрасывается. При этом сведения о дате останутся в исходном значении Date и могут быть извлечены с помощью таких функций, как DatePart.

Примечание.
Если аргумент Expression передается как литерал String, FormatDateTime интерпретирует его в соответствии с параметром CurrentCulture приложения. Однако в случае, когда он передается как литерал Date, используйте формат #мм/дд/гггг#, поскольку FormatDateTime всегда интерпретирует литерал Date согласно английскому языку и региональным параметрам (США). Такая необходимость определяется тем, что если приложение разрабатывается и кодируется с использованием литералов Date из одного языка, а затем выполняется на другой языковой платформе, синтаксический анализ литералов Date может выполняться неправильно.

Если аргумент Expression передается как литерал String, FormatDateTime интерпретирует его в соответствии с параметром CurrentCulture приложения. Однако в случае, когда он передается как литерал Date, используйте формат #мм/дд/гггг#, поскольку FormatDateTime всегда интерпретирует литерал Date согласно английскому языку и региональным параметрам (США). Такая необходимость определяется тем, что если приложение разрабатывается и кодируется с использованием литералов Date из одного языка, а затем выполняется на другой языковой платформе, синтаксический анализ литералов Date может выполняться неправильно.

Пример

В данном примере показано применение функции FormatDateTime.

' English (US) format.
Dim TestDate As DateTime = #3/12/1999#

' FormatDateTime returns "Friday, March 12, 1999".
' The time information is neutral (00:00:00) and therefore suppressed.
Dim TestString As String = FormatDateTime(TestDate, DateFormat.LongDate)