FormatDateTime, fonction (Visual Basic)

Article
09/12/2008

Mise à jour : novembre 2007

Retourne une expression de chaîne représentant une valeur de date/d'heure.

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

Paramètres

Expression
Requis. Expression Date à mettre en forme.
NamedFormat
Facultatif. Valeur numérique qui indique le format de date/d'heure utilisé. Si cette valeur est omise, DateFormat.GeneralDate est utilisé.

Paramètres

L'argument NamedFormat possède les paramètres suivants :

Constante	Description
DateFormat.GeneralDate	Affiche une date et/ou une heure. Affiche une partie de date sous forme de date courte. En présence d'une partie de date, elle l'affiche sous forme d'heure complète. Si elles sont présentes, les deux parties sont affichées.
DateFormat.LongDate	Affiche une date au format de date longue spécifié dans les paramètres régionaux de votre ordinateur.
DateFormat.ShortDate	Affiche une date au format de date courte spécifié dans les paramètres régionaux de votre ordinateur.
DateFormat.LongTime	Affiche une heure au format d'heure spécifié dans les paramètres régionaux de votre ordinateur.
DateFormat.ShortTime	Affiche une heure au format 24 heures (hh:mm).

Exceptions

Type d'exception	Numéro d'erreur	Condition
ArgumentException	5	Le paramètre NamedFormat n'est pas valide.

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

Le type de données Date contient toujours des informations sur la date et l'heure. Dans le cadre de la conversion de type, Visual Basic considère la valeur 1/1/1 (le 1er janvier de l'année 1) comme une valeur neutre pour la date et 00:00:00 (minuit) comme une valeur neutre pour l'heure. Si vous formatez une valeur Date en chaîne de date/d'heure, FormatDateTime n'inclut pas de valeurs neutres dans la chaîne résultante. Par exemple, si vous convertissez #1/1/0001 9:30:00# en chaîne, le résultat est "9:30:00 AM" ; les informations de date ayant été supprimées. Cependant, les informations de date se trouvent toujours dans la valeur Date d'origine et peuvent être récupérées à l'aide de fonctions telles que DatePart.

Remarque :
Si vous passez l'argument Expression comme un littéral String, FormatDateTime l'interprète en fonction du paramètre CurrentCulture de votre application. Cependant, si vous le passez comme un littéral Date, vous devez utiliser le format #mm/dd/yyyy#, car FormatDateTime interprète toujours un littéral de Date en fonction de la culture anglo-américaine. Cela est nécessaire, car si une application est développée et codée à l'aide de littéraux Date provenant d'une certaine culture, puis exécutée sur une plateforme d'une autre culture, les littéraux Date peuvent être mal analysés.

Si vous passez l'argument Expression comme un littéral String, FormatDateTime l'interprète en fonction du paramètre CurrentCulture de votre application. Cependant, si vous le passez comme un littéral Date, vous devez utiliser le format #mm/dd/yyyy#, car FormatDateTime interprète toujours un littéral de Date en fonction de la culture anglo-américaine. Cela est nécessaire, car si une application est développée et codée à l'aide de littéraux Date provenant d'une certaine culture, puis exécutée sur une plateforme d'une autre culture, les littéraux Date peuvent être mal analysés.

Exemple

L'exemple ci-dessous illustre l'utilisation de la fonction 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)