GetCalendarDateFormatEx-Funktion

Artikel
06/13/2023

Veraltet. Ruft eine ordnungsgemäß formatierte Datumszeichenfolge für das angegebene Gebietsschema unter Verwendung des angegebenen Datums und Kalenders ab. Der Benutzer kann das kurze Datumsformat, das Lange Datumsformat, das Jahresmonatsformat oder ein benutzerdefiniertes Formatmuster angeben.

Hinweis

Diese Funktion kann Daten abrufen, die sich zwischen Releases ändern, z. B. aufgrund eines benutzerdefinierten Gebietsschemas. Wenn Ihre Anwendung Daten beibehalten oder übertragen muss, finden Sie weitere Informationen unter Verwenden persistenter Gebietsschemadaten.

Syntax

BOOL GetCalendarDateFormatEx(
  _In_        LPCWSTR       lpszLocale,
  _In_        DWORD         dwFlags,
  _In_  const LPCALDATETIME lpCalDateTime,
  _In_        LPCWSTR       lpFormat,
  _Out_       LPWSTR        lpDateStr,
  _In_        int           cchDate
);

Parameter

lpszLocale [in]

Zeiger auf einen Gebietsschemanamen oder einen der folgenden vordefinierten Werte.

dwFlags [in]

Flags, die Datumsformatoptionen angeben. Wenn lpFormat nicht auf NULL festgelegt ist, muss dieser Parameter auf 0 festgelegt werden. Wenn lpFormat auf NULL festgelegt ist, kann die Anwendung eine Kombination aus den folgenden Werten und LOCALE_NOUSEROVERRIDE angeben.

Wert	Bedeutung
DATE_SHORTDATE	Verwenden Sie das kurze Datumsformat. Dies ist die Standardeinstellung. Dieser Wert kann nicht mit DATE_LONGDATE oder DATE_YEARMONTH verwendet werden.
DATE_LONGDATE	Verwenden Sie das Lange Datumsformat. Dieser Wert kann nicht mit DATE_SHORTDATE oder DATE_YEARMONTH verwendet werden.
DATE_YEARMONTH	Verwenden Sie das Format Jahr/Monat. Dieser Wert kann nicht mit DATE_SHORTDATE oder DATE_LONGDATE verwendet werden.
DATE_LTRREADING	Fügen Sie Markierungen für das Leselayout von links nach rechts hinzu. Dieser Wert kann nicht mit DATE_RTLREADING verwendet werden.
DATE_RTLREADING	Fügen Sie Markierungen für das Leselayout von rechts nach links hinzu. Dieser Wert kann nicht mit DATE_LTRREADING verwendet werden.

lpCalDateTime [in]

Zeiger auf eine CALDATETIME-Struktur , die die zu formatierenden Datums- und Kalenderinformationen enthält.

lpFormat [in]

Zeiger auf eine Formatbildzeichenfolge, die zum Bilden der Datumszeichenfolge verwendet wird. Mögliche Werte für die Formatbildzeichenfolge sind in Bildern im Tag-, Monats-, Jahres- und Epochenformat definiert.

Die Formatbildzeichenfolge muss NULL-endend sein. Die Funktion verwendet das Gebietsschema nur für Informationen, die nicht in der Bildzeichenfolge im Format angegeben sind, z. B. den Tag- und Monatsnamen für das Gebietsschema. Die Anwendung legt diesen Parameter auf NULL fest, wenn die Funktion das Datumsformat des angegebenen Gebietsschemas verwenden soll.

lpDateStr [out]

Zeiger auf einen Puffer, in dem diese Funktion die formatierte Datumszeichenfolge empfängt.

cchDate [in]

Größe des lpDateStr-Puffers in Zeichen. Alternativ kann die Anwendung diesen Parameter auf 0 festlegen. In diesem Fall gibt die Funktion die Anzahl der Zeichen zurück, die zum Speichern der formatierten Datumszeichenfolge erforderlich sind, und der lpDateStr-Parameter wird nicht verwendet.

Rückgabewert

Gibt die Anzahl der Zeichen zurück, die bei erfolgreicher Ausführung in den Puffer lpDateStr geschrieben wurden. Wenn der cchDate-Parameter auf 0 festgelegt ist, gibt die Funktion die Anzahl der Zeichen zurück, die zum Speichern der formatierten Datumszeichenfolge erforderlich sind, einschließlich des beendenden NULL-Zeichens.

Diese Funktion gibt 0 zurück, wenn sie nicht erfolgreich ist. Um erweiterte Fehlerinformationen abzurufen, kann die Anwendung GetLastError aufrufen, wodurch einer der folgenden Fehlercodes zurückgegeben werden kann:

ERROR_DATE_OUT_OF_RANGE. Das angegebene Datum lag außerhalb des Bereichs.
ERROR_INSUFFICIENT_BUFFER. Eine angegebene Puffergröße war nicht groß genug, oder sie wurde fälschlicherweise auf NULL festgelegt.
ERROR_INVALID_FLAGS. Die für Flags angegebenen Werte waren ungültig.
ERROR_INVALID_PARAMETER. Jeder der Parameterwerte war ungültig.

Bemerkungen

Das früheste von dieser Funktion unterstützte Datum ist der 1. Januar 1601.

Diese Funktion verfügt nicht über eine zugeordnete Header- oder Bibliotheksdatei. Die Anwendung kann LoadLibrary mit dem DLL-Namen (Kernel32.dll) aufrufen, um ein Modulhandle abzurufen. Anschließend kann getProcAddress mit diesem Modulhandle und dem Namen dieser Funktion aufgerufen werden, um die Funktionsadresse abzurufen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
DLL	Kernel32.dll

Siehe auch

Unterstützung für nationale Sprachen
Nationale Sprachunterstützungsfunktionen
Bilder im Tag-, Monats-, Jahres- und Epochenformat
NLS: Beispiel für namenbasierte APIs
EnumDateFormatsExEx
GetDateFormat
GetDateFormatEx
CALDATETIME

Freigeben über