DatePart (Función, Visual Basic)

Artículo
10/07/2008

Actualización: noviembre 2007

Devuelve un valor Integer que contiene el componente especificado de un valor Date dado.

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

Parámetros

Interval
Requerido. Valor de enumeración DateInterval o expresión String que representa la parte del valor de fecha u hora que se desea devolver.
DateValue
Requerido. Valor de tipo Date que se desea evaluar.
FirstDayOfWeekValueDayOfWeek
Opcional. Un valor elegido de la enumeración FirstDayOfWeek que especifica el primer día de la semana. Si no se especifica, se utiliza FirstDayOfWeek.Sunday.
FirstWeekOfYearValueWeekOfYear
Opcional. Valor elegido de la enumeración FirstWeekOfYear que especifica la primera semana del año. Si no se especifica, se utiliza FirstWeekOfYear.Jan1.

Valores

El argumento Interval puede tener uno de los siguientes valores:

Valor de enumeración	Cadena	Parte del valor de fecha u hora devuelta
DateInterval.Day	d	Día del mes (del 1 al 31)
DateInterval.DayOfYear	y	Día del año (del 1 al 366)
DateInterval.Hour	h	Hora
DateInterval.Minute	n	Minuto
DateInterval.Month	m	Mes
DateInterval.Quarter	q	Trimestre
DateInterval.Second	s	Segundo
DateInterval.Weekday	w	Día de la semana (del 1 al 7)
DateInterval.WeekOfYear	ww	Semana del año (de la 1 a la 53)
DateInterval.Year	yyyy	Año

El argumento FirstDayOfWeekValue puede tener uno de los siguientes valores:

Valor de enumeración	Valor	Descripción
FirstDayOfWeek.System		Primer día de la semana especificado en la configuración del sistema
FirstDayOfWeek.Sunday		Domingo (predeterminado)
FirstDayOfWeek.Monday		Lunes (de acuerdo con la norma ISO 8601, sección 3.17)
FirstDayOfWeek.Tuesday		Martes
FirstDayOfWeek.Wednesday		Miércoles
FirstDayOfWeek.Thursday		Jueves
FirstDayOfWeek.Friday		Viernes
FirstDayOfWeek.Saturday		Sábado

El argumento FirstWeekOfYearValue puede tener uno de los siguientes valores:

Valor de enumeración	Valor	Descripción
FirstWeekOfYear.System		Primera semana del año especificada en la configuración del sistema
FirstWeekOfYear.Jan1		Semana en la que se encuentra el 1 de enero (predeterminado)
FirstWeekOfYear.FirstFourDays		Semana que contiene al menos cuatro días del nuevo año (de acuerdo con la norma ISO 8601, sección 3.17)
FirstWeekOfYear.FirstFullWeek		Primera semana completa del nuevo año

Excepciones

Tipo de excepción	Número de error	Condición
ArgumentException		Interval no es válido.
InvalidCastException		DateValue no está establecido en Date.

Consulte la columna "Número de error" si está actualizando aplicaciones de Visual Basic 6.0 que utilizan el control de errores no estructurado. (Se puede comparar el número de error con respecto a Number (Propiedad, objeto Err)). Sin embargo, siempre que sea posible, se debe considerar la sustitución de dicho control de errores por Información general sobre el control estructurado de excepciones de Visual Basic.

Comentarios

Se puede utilizar la función DatePart para evaluar un valor de fecha u hora y devolver un componente específico. Por ejemplo, se podría utilizar DatePart para calcular el día de la semana o la hora actual.

Si elige DateInterval.Weekday para el argumento Interval, el valor devuelto es coherente con los valores de la enumeración FirstDayOfWeek. Si elige DateInterval.WeekOfYear, DatePart utiliza las clases Calendar y CultureInfo del espacio de nombres System.Globalization para determinar la configuración actual.

El argumento FirstDayOfWeekValue afecta a los cálculos que utilizan la configuración DateInterval.Weekday y DateInterval.WeekOfYear en Interval. El argumento FirstWeekOfYearValue afecta a los cálculos que especifican DateInterval.WeekOfYear en Interval.

Puesto que todos los valores Date se basan en una estructura DateTime, sus métodos proporcionan opciones adicionales para recuperar partes de fecha u hora. Por ejemplo, se puede obtener el valor de fecha completo de una variable Date, con el valor de hora establecido en medianoche, como se muestra a continuación:

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

Ejemplo

En este ejemplo se utiliza la función DatePart sobre una fecha para mostrar el trimestre del año en que se produce.

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)