GetDateFormatWrapW-Funktion

[GetDateFormatWrapWrapW ist zur Verwendung in Windows XP verfügbar. Sie ist in nachfolgenden Versionen nicht verfügbar. Sie sollten GetDateFormatW an seiner Stelle verwenden.]

Formatiert ein Datum als Datumszeichenfolge für ein angegebenes Gebietsschema. Die Funktion formatiert entweder ein angegebenes Datum oder das lokale Systemdatum.

Hinweis

GetDateFormatWrapW ist ein Wrapper für die GetDateFormatW-Funktion . Weitere Nutzungshinweise finden Sie auf der Seite GetDateFormat .

 

Syntax

int GetDateFormatWrapW(
  _In_        LCID       Locale,
  _In_        DWORD      dwFlags,
  _In_  const SYSTEMTIME *lpDate,
  _In_        LPCWSTR    pwzFormat,
  _Out_       LPWSTR     pwzDateStr,
  _In_        int        cchDate
);

Parameter

Gebietsschema [in]

Typ: LCID

Das Gebietsschema, für das die Datumszeichenfolge formatiert werden soll. Wenn pwzFormatNULL ist, formatiert die Funktion die Zeichenfolge entsprechend dem Datumsformat für dieses Gebietsschema. Wenn pwzFormat nicht NULL ist, verwendet die Funktion das Gebietsschema nur für Informationen, die nicht in der Bildzeichenfolge im Format angegeben sind (z. B. die Tag- und Monatsnamen des Gebietsschemas).

Bei diesem Parameter kann es sich um einen Gebietsschemabezeichner handeln, der vom MAKELCID-Makro erstellt wurde, oder um einen der folgenden vordefinierten Werte.

LOCALE_SYSTEM_DEFAULT

Standardsystemgebietsschema.

LOCALE_USER_DEFAULT

Standardbenutzergebietsschema.

dwFlags [in]

Art: DWORD

Gibt verschiedene Funktionsoptionen an. Wenn pwzFormat nicht NULL ist, muss dieser Parameter null sein. Wenn pwzFormatNULL ist, können Sie eine Kombination der folgenden Werte angeben. Wenn Sie weder DATE_YEARMONTH, DATE_SHORTDATE noch DATE_LONGDATE angeben und pwzFormatnull ist, wird DATE_SHORTDATE als Standard verwendet.

LOCALE_NOUSEROVERRIDE

Wenn festgelegt, formatiert die Funktion die Zeichenfolge mit dem Standarddatumsformat des Systems für das angegebene Gebietsschema. Wenn sie nicht festgelegt ist, formatiert die Funktion die Zeichenfolge mithilfe von Benutzerüberschreibungen in das Standarddatumsformat des Gebietsschemas.

LOCALE_USE_CP_ACP

Verwendet die System-ANSI-Codepage für die Zeichenfolgenübersetzung anstelle der Codepage des Gebietsschemas.

DATE_SHORTDATE

Verwendet das kurze Datumsformat. Dieser Wert kann nicht mit DATE_LONGDATE oder DATE_YEARMONTH verwendet werden.

DATE_LONGDATE

Verwendet das lange Datumsformat. Dieser Wert kann nicht mit DATE_SHORTDATE oder DATE_YEARMONTH verwendet werden.

DATE_YEARMONTH

Verwendet das Format "Jahr/Monat". Dieser Wert kann nicht mit DATE_SHORTDATE oder DATE_LONGDATE verwendet werden.

DATE_USE_ALT_CALENDAR

Verwendet den alternativen Kalender, sofern vorhanden, zum Formatieren der Datumszeichenfolge. Wenn dieses Flag festgelegt ist, verwendet die Funktion anstelle von Benutzerüberschreibungen das Standardformat für diesen alternativen Kalender. Die Benutzerüberschreibungen werden nur verwendet, wenn kein Standardformat für den angegebenen alternativen Kalender vorhanden ist.

DATE_LTRREADING

Fügt Markierungen für das Leselayout von links nach rechts hinzu. Dieser Wert kann nicht mit DATE_RTLREADING verwendet werden.

DATE_RTLREADING

Fügt Markierungen für das Leselayout von rechts nach links hinzu. Dieser Wert kann nicht mit DATE_LTRREADING verwendet werden.

lpDate [in]

Typ: const SYSTEMTIME*

Ein Zeiger auf eine SYSTEMTIME-Struktur , die die zu formatierenden Datumsinformationen enthält. Wenn dieser Zeiger NULL ist, verwendet die Funktion das aktuelle lokale Systemdatum.

pwzFormat [in]

Typ: LPCWSTR

Ein Zeiger auf ein Formatbild, das zum Bilden der Datumszeichenfolge verwendet werden soll. Wenn pwzFormatNULL ist, verwendet die Funktion das Datumsformat des angegebenen Gebietsschemas. Weitere Informationen finden Sie unter GetDateFormat .

pwzDateStr [out]

Typ: LPWSTR

Ein Zeiger auf einen Puffer, der die formatierte Datumszeichenfolge empfängt.

cchDate [in]

Typ: int

Gibt die Größe des pwzDateStr-Puffers in Zeichen an. Wenn cchDate null ist, gibt die Funktion die Anzahl der Zeichen zurück, die zum Speichern der formatierten Datumszeichenfolge erforderlich sind, und der Puffer, auf den pwzDateStr verweist, wird nicht verwendet.

Rückgabewert

Typ: int

Wenn die Funktion erfolgreich ist, ist der Rückgabewert die Anzahl der Zeichen, die in den Puffer geschrieben werden, auf den pwzDateStr zeigt. Wenn der cchDate-Parameter null ist, ist der Rückgabewert die Anzahl der Zeichen, die zum Speichern der formatierten Datumszeichenfolge erforderlich sind. Die Anzahl enthält das abschließende NULL-Zeichen.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf. GetLastError gibt möglicherweise einen der folgenden Fehlercodes zurück.

ERROR_INSUFFICIENT_BUFFER

ERROR_INVALID_FLAGS

ERROR_INVALID_PARAMETER

Bemerkungen

GetDateFormatWrapW bietet die Möglichkeit, Unicode-Zeichenfolgen in Betriebssystemen vor Windows XP zu verwenden. Die bevorzugte Methode ist die Verwendung von GetDateFormatW in Verbindung mit Microsoft Layer for Unicode (MSLU).

GetDateFormatWrapW muss mithilfe von Ordinal 311 direkt aus Shlwapi.dll aufgerufen werden.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
DLL	Shlwapi.dll (Version 5.0 oder höher)

Siehe auch

GetDateFormat