DatePart, fonction (Visual Basic)

Article
09/12/2008

Mise à jour : novembre 2007

Retourne une valeur de type Integer contenant le composant spécifié d'une valeur Date donnée.

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

Paramètres

Interval
Requis. Valeur d'énumération DateInterval ou expression String représentant la partie de la valeur date/heure que vous souhaitez retourner.
DateValue
Requis. Valeur Date à évaluer.
FirstDayOfWeekValue, DayOfWeek
Facultatif. Valeur choisie dans l'énumération FirstDayOfWeek qui spécifie le premier jour de la semaine. S'il n'est pas spécifié, FirstDayOfWeek.Sunday est utilisé.
FirstWeekOfYearValue, WeekOfYear
Facultatif. Valeur choisie dans l'énumération FirstWeekOfYear qui spécifie la première semaine de l'année. S'il n'est pas spécifié, FirstWeekOfYear.Jan1 est utilisé.

Paramètres

L'argument Interval peut prendre l'une des valeurs suivantes :

Valeur d'énumération	Chaîne	Partie de la valeur date/heure à retourner
DateInterval.Day	d	Jour du mois (1 à 31)
DateInterval.DayOfYear	y	Jour de l'année (1 à 366)
DateInterval.Hour	h	Heure
DateInterval.Minute	n	Minute
DateInterval.Month	m	Mois
DateInterval.Quarter	q	Trimestre
DateInterval.Second	s	Seconde
DateInterval.Weekday	w	Jour de la semaine (1 à 7)
DateInterval.WeekOfYear	ww	Semaine de l'année (1 à 53)
DateInterval.Year	yyyy	Année

L'argument FirstDayOfWeekValue peut prendre l'une des valeurs suivantes :

Valeur d'énumération	Valeur	Description
FirstDayOfWeek.System	0	Premier jour de la semaine spécifiée dans les paramètres système
FirstDayOfWeek.Sunday	1	Dimanche (valeur par défaut)
FirstDayOfWeek.Monday	2	Lundi (conformément à la norme ISO 8601, section 3.17)
FirstDayOfWeek.Tuesday	3	Mardi
FirstDayOfWeek.Wednesday	4	Mercredi
FirstDayOfWeek.Thursday	5	Jeudi
FirstDayOfWeek.Friday	6	Vendredi
FirstDayOfWeek.Saturday	7	Samedi

L'argument FirstWeekOfYearValue peut prendre l'une des valeurs suivantes :

Valeur d'énumération	Valeur	Description
FirstWeekOfYear.System	0	Première semaine de l'année spécifiée dans les paramètres système
FirstWeekOfYear.Jan1	1	Semaine comprenant le 1er janvier (valeur par défaut).
FirstWeekOfYear.FirstFourDays	2	Semaine comprenant au moins 4 jours de la nouvelle année (conformément à la norme ISO 8601, section 3.17)
FirstWeekOfYear.FirstFullWeek	3	Première semaine entière de la nouvelle année

Exceptions

Type d'exception	Numéro de l'erreur	Condition
ArgumentException	5	Interval n'est pas valide.
InvalidCastException	13	DateValue ne peut pas être converti en Date.

Consultez la colonne « Numéro d'erreur » si vous mettez à niveau des applications Visual Basic 6.0 qui utilisent la gestion non structurée des erreurs. (Vous pouvez comparer le numéro d'erreur par rapport à Number, propriété (objet Err).) Toutefois, lorsque cela est possible, vous devez envisager de remplacer un tel contrôle d'erreurs par Vue d'ensemble de la gestion structurée des exceptions pour Visual Basic.

Notes

Utilisez la fonction DatePart pour évaluer une valeur date/heure et retourner un composant spécifique. Par exemple, utilisez la fonction DatePart pour calculer le jour de la semaine ou l'heure en cours.

Si vous choisissez DateInterval.Weekday pour l'argument Interval, la valeur retournée est cohérente avec les valeurs de l'énumération FirstDayOfWeek. Si vous choisissez DateInterval.WeekOfYear, DatePart utilise les classes Calendar et CultureInfo de l'espace de noms System.Globalization pour déterminer vos paramètres actuels.

L'argument FirstDayOfWeekValue affecte des calculs qui utilisent les paramètres Interval de DateInterval.Weekday et de DateInterval.WeekOfYear. L'argument FirstWeekOfYearValue affecte des calculs qui spécifient DateInterval.WeekOfYear pour Interval.

Étant donné que chaque valeur Date est prise en charge par une structure DateTime, ses méthodes vous donnent des possibilités supplémentaires pour récupérer des éléments de date/heure. Vous pouvez, par exemple, obtenir la valeur date complète d'une variable Date, la valeur heure étant minuit, comme dans le code suivant :

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

Exemple

Cet exemple prend une date et affiche le trimestre de l'année en question, à l'aide de la fonction 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)