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

Статья
11/05/2008

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

Возвращает значение типа Integer, содержащее указанный компонент заданного значения с типом Date.

Public Overloads Function DatePart( _
   ByVal Interval As DateInterval, _
   ByVal DateValue As DateTime, _
   Optional ByVal FirstDayOfWeekValue As FirstDayOfWeek = VbSunday, _
   Optional ByVal FirstWeekOfYearValue As FirstWeekOfYear = VbFirstJan1 _
) As Integer
' -or-
Public Overloads Function DatePart( _
    ByVal Interval As String, _
   ByVal DateValue As Object, _
   Optional ByVal DayOfWeek As FirstDayOfWeek = FirstDayOfWeek.Sunday, _
   Optional ByVal WeekOfYear As FirstWeekOfYear = FirstWeekOfYear.Jan1 _
) As Integer

Параметры

Interval
Обязательный. Значение перечисления DateInterval или выражение типа String, представляющие возвращаемую часть даты или времени.
DateValue
Обязательный. Значение Date, которое требуется вычислить.
FirstDayOfWeekValue, DayOfWeek
Необязательный. Значение, выбранное из перечисления FirstDayOfWeek, которое указывает первый день недели. Если не указано, то используется FirstDayOfWeek.Sunday.
FirstWeekOfYearValue, WeekOfYear
Необязательный. Значение, выбранное из перечисления FirstWeekOfYear, которое указывает первую неделю года. Если не указано, то используется FirstWeekOfYear.Jan1.

Параметры

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

Значение перечисления	Строка	Возвращаемая часть значения даты или времени
DateInterval.Day	d	День месяца (от 1 до 31)
DateInterval.DayOfYear	y	День года (от 1 до 366)
DateInterval.Hour	h	Час
DateInterval.Minute	n	Минута
DateInterval.Month	m	Месяц
DateInterval.Quarter	q	Квартал
DateInterval.Second	s	Секунда
DateInterval.Weekday	w	День недели (от 1 до 7)
DateInterval.WeekOfYear	ww	Неделя года (от 1 до 53)
DateInterval.Year	yyyy	Год

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

Значение перечисления	Значение	Описание
FirstDayOfWeek.System	0	Первый день недели, заданный в настройках системы
FirstDayOfWeek.Sunday	1	Воскресенье (по умолчанию)
FirstDayOfWeek.Monday	2	Понедельник (соответствует стандарту ISO 8601, раздел 3.17)
FirstDayOfWeek.Tuesday	3	Вторник
FirstDayOfWeek.Wednesday	4	Среда
FirstDayOfWeek.Thursday	5	Четверг
FirstDayOfWeek.Friday	6	Пятница
FirstDayOfWeek.Saturday	7	Суббота

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

Значение перечисления	Значение	Описание
FirstWeekOfYear.System	0	Первая неделя года, заданная в настройках системы
FirstWeekOfYear.Jan1	1	Неделя, на которую приходится 1 января (по умолчанию)
FirstWeekOfYear.FirstFourDays	2	Неделя, на которую приходится, по крайней мере, четыре дня нового года (соответствует стандарту ISO 8601, раздел 3.17)
FirstWeekOfYear.FirstFullWeek	3	Первая полная неделя в новом году

Исключения

Тип исключения	Номер ошибки	Условие
ArgumentException	5	Недопустимое значение параметра Interval.
InvalidCastException	13	DateValue не может быть приведен к Date.

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

Заметки

Функцию DatePart можно использовать, чтобы оценить значение даты или времени и вернуть определенный компонент. Например, можно использовать функцию DatePart для вычисления дня недели или текущего часа.

Если для Interval выбран аргумент DateInterval.Weekday, возвращаемое значение согласовано со значениями из перечисления FirstDayOfWeek. Если выбрано DateInterval.WeekOfYear, DatePart использует Calendar и классы пространства имен CultureInfo System.Globalization для определения текущих настроек.

Аргумент FirstDayOfWeekValue влияет на вычисления, использующие параметры DateInterval.Weekday и DateInterval.WeekOfYear Interval. Аргумент FirstWeekOfYearValue влияет на вычисления, которые определяют DateInterval.WeekOfYear для Interval.

Поскольку все значения Date поддерживаются структурой DateTime, ее методы предоставляют дополнительные возможности для извлечения частей значений даты или времени. Например, полное значение даты со значением времени, установленным равным полночи, можно получить из переменной Date следующим образом.

Dim CurrDatTim As Date = Now   ' Current date and time.
Dim LastMidnight As Date = CurrDatTim.Date   ' At midnight.

Пример

В этом примере для указанной даты с помощью функции DatePart отображается квартал года, в котором находится эта дата.

Dim FirstDate, Msg As String   'Declare variables.
Dim SecondDate As Date
FirstDate = InputBox("Enter a date:")
SecondDate = CDate(FirstDate)
Msg = "Quarter: " & DatePart(DateInterval.Quarter, SecondDate)
MsgBox(Msg)