Strings.FormatDateTime, méthode

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

Espace de noms : Microsoft.VisualBasic
Assembly : Microsoft.VisualBasic (dans microsoft.visualbasic.dll)

Syntaxe

'Déclaration
Public Shared Function FormatDateTime ( _
    Expression As DateTime, _
    <OptionalAttribute> Optional NamedFormat As DateFormat = DateFormat.GeneralDate _
) As String
'Utilisation
Dim Expression As DateTime
Dim NamedFormat As DateFormat
Dim returnValue As String

returnValue = Strings.FormatDateTime(Expression, NamedFormat)

public static string FormatDateTime (
    DateTime Expression,
    [OptionalAttribute] DateFormat NamedFormat
)

public:
static String^ FormatDateTime (
    DateTime Expression, 
    [OptionalAttribute] DateFormat NamedFormat
)

public static String FormatDateTime (
    DateTime Expression, 
    /** @attribute OptionalAttribute() */ DateFormat NamedFormat
)

public static function FormatDateTime (
    Expression : DateTime, 
    NamedFormat : DateFormat
) : String

Paramètres

• Expression
  Obligatoire. 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é.

Valeur de retour

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

Notes

Pour plus d'informations, consultez la rubrique Visual Basic FormatDateTime, fonction (Visual Basic).

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 appliquez à une valeur Date un format qui la convertit en chaîne de date/d'heure, FormatDateTime n'inclut pas de valeurs neutres dans la chaîne obtenue. Par exemple, si vous convertissez #1/1/0001 9:30:00# en chaîne, le résultat est "9:30:00 AM" ; l'information de date est supprimée. Toutefois, l'information de date est encore présente dans la valeur Date d'origine et peut être récupérée avec des fonctions telles que DatePart.

Notes

Si vous passez l'argument Expression en tant que littéral String, FormatDateTime l'interprète selon le paramètre CurrentCulture de votre application. Toutefois, si vous le passez en tant que littéral Date, utilisez le format #mm/jj/aaaa#, car FormatDateTime interprète toujours un littéral Date selon la culture Anglais (États-Unis). Cela permet en effet d'éviter, lorsqu'une application est développée et codée à l'aide des littéraux Date d'une culture, puis exécutée sur une plate-forme avec une culture différente, que les littéraux Date soient incorrectement analysés.

Les paramètres de l'argument NamedFormat sont les suivants :

Constante	Description
DateFormat.GeneralDate	Affiche une date et/ou une heure. Affiche une partie date comme une date courte. S'il y a une partie heure, l'affiche comme une heure complète. Si les deux parties sont présentes, les deux s'affichent.
DateFormat.LongDate	Affiche une date dans le format de date longue spécifié dans les paramètres régionaux de votre ordinateur.
DateFormat.ShortDate	Affiche une date dans le format de date courte spécifié dans les paramètres régionaux de votre ordinateur.
DateFormat.LongTime	Affiche une heure dans le format d'heure spécifié dans les paramètres régionaux de votre ordinateur.
DateFormat.ShortTime	Affiche une heure selon le format 24 heures (hh:mm).

Exemple

Cet exemple 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)

Plates-formes

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile pour Pocket PC, Windows Mobile pour Smartphone, Windows Server 2003, Windows XP Édition Media Center, Windows XP Professionnel Édition x64, Windows XP SP2, Windows XP Starter Edition

Le .NET Framework ne prend pas en charge toutes les versions de chaque plate-forme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise.

Informations de version

.NET Framework

Prise en charge dans : 2.0, 1.1, 1.0

.NET Compact Framework

Prise en charge dans : 2.0, 1.0

Voir aussi

Référence

Strings, classe
Membres Strings
Microsoft.VisualBasic, espace de noms
ArgumentException

Autres ressources

FormatDateTime, fonction (Visual Basic)
FormatCurrency, fonction (Visual Basic)
FormatNumber, fonction (Visual Basic)
FormatPercent, fonction (Visual Basic)
DatePart, fonction (Visual Basic)
Liste des manipulations de chaînes