FormatDateTime-Funktion (Visual Basic)

Artikel
09/02/2008

Aktualisiert: November 2007

Gibt einen Zeichenfolgenausdruck für einen Datums- und Uhrzeitwert zurück.

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

Parameter

Expression
Erforderlich. Zu formatierender Date-Ausdruck.
NamedFormat
Optional. Numerischer Wert, der das verwendete Datums- und Zeitformat angibt. Wenn kein Wert angegeben wird, wird DateFormat.GeneralDate verwendet.

Einstellungen

Das NamedFormat-Argument hat folgende Einstellungen.

Konstante	Beschreibung
DateFormat.GeneralDate	Zeigt Datum und/oder Uhrzeit an. Zeigt einen Datumsteil als kurzes Datum an. Wenn es einen Zeitteil gibt, erfolgt die Anzeige im langen Zeitformat. Wenn vorhanden, werden beide Teile angezeigt.
DateFormat.LongDate	Zeigt ein Datum im langen Datumsformat an, das in den Ländereinstellungen des Computers festgelegt wurde.
DateFormat.ShortDate	Zeigt ein Datum im kurzen Datumsformat an, das in den Ländereinstellungen des Computers festgelegt wurde.
DateFormat.LongTime	Zeigt eine Uhrzeit in dem Zeitformat an, das in den Ländereinstellungen des Computers festgelegt wurde.
DateFormat.ShortTime	Zeigt eine Uhrzeit im 24-Stundenformat (hh:mm) an.

Ausnahmen

Ausnahmetyp	Fehlernummer	Bedingung
ArgumentException	5	Die Einstellung NamedFormat ist nicht gültig.

Beachten Sie die Spalte "Fehlernummer", wenn Sie Visual Basic 6.0-Anwendungen aktualisieren, die eine unstrukturierte Fehlerbehandlung verwenden. (Sie können die Fehlernummer mit der Number-Eigenschaft (Err-Objekt) vergleichen.) Wenn möglich, sollten Sie jedoch erwägen, eine solche Fehlersteuerung durch eine Übersicht über die strukturierte Ausnahmebehandlung für Visual Basic zu ersetzen.

Hinweise

Der Datentyp Date enthält immer sowohl Datums- als auch Zeitinformationen. Für die Typkonvertierung verwendet Visual Basic 1/1/1 (1. Januar des Jahres 1) als neutralen Datumswert und 00:00:00 (Mitternacht) als neutralen Wert für die Uhrzeit. Wenn ein Date-Wert als Datums-/Uhrzeitzeichenfolge formatiert wird, nimmt FormatDateTime in die resultierende Zeichenfolge keine neutralen Werte auf. Wenn beispielsweise #1/1/0001 9:30:00# in eine Zeichenfolge umgewandelt wird, lautet das Ergebnis "9:30:00 AM"; die Datumsinformationen werden unterdrückt. Die Datumsinformationen sind dabei im ursprünglichen Date-Wert noch enthalten und können mit Funktionen wie DatePart wiederhergestellt werden.

Hinweis:
Wenn das Expression-Argument als String-Literal übergeben wird, interpretiert FormatDateTime das Argument entsprechend der CurrentCulture-Einstellung der Anwendung. Wenn Sie es jedoch als Date-Literal übergeben, verwenden Sie das Format #mm/dd/yyyy#, da FormatDateTime ein Date-Literal immer gemäß der US-amerikanischen Kultur interpretiert. Dies ist aus folgendem Grund erforderlich: Wenn eine Anwendung mit Date-Literalen aus einer Kultur entwickelt und codiert wird, dann aber auf einer Plattform für eine andere Kultur ausgeführt wird, werden die Date-Literale u. U. fehlerhaft analysiert.

Wenn das Expression-Argument als String-Literal übergeben wird, interpretiert FormatDateTime das Argument entsprechend der CurrentCulture-Einstellung der Anwendung. Wenn Sie es jedoch als Date-Literal übergeben, verwenden Sie das Format #mm/dd/yyyy#, da FormatDateTime ein Date-Literal immer gemäß der US-amerikanischen Kultur interpretiert. Dies ist aus folgendem Grund erforderlich: Wenn eine Anwendung mit Date-Literalen aus einer Kultur entwickelt und codiert wird, dann aber auf einer Plattform für eine andere Kultur ausgeführt wird, werden die Date-Literale u. U. fehlerhaft analysiert.

Beispiel

In diesem Beispiel wird die Verwendung der FormatDateTime-Funktion gezeigt.

' 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)