GetTimeFormatWrapWrapW-Funktion

[GetTimeFormatWrapWrapW ist für die Verwendung in Windows XP verfügbar. In nachfolgenden Versionen ist sie möglicherweise nicht verfügbar. Sie sollten GetTimeFormatW an seiner Stelle verwenden.]

Formatiert zeit als Zeitzeichenfolge für ein angegebenes Gebietsschema. Die Funktion formatiert entweder eine angegebene Zeit oder die lokale Systemzeit.

Hinweis

GetTimeFormatWrapW ist ein Wrapper für die GetTimeFormatW-Funktion . Weitere Nutzungshinweise finden Sie auf der Seite GetTimeFormat .

 

Syntax

int GetTimeFormatWrapW(
  _In_        LCID       Locale,
  _In_        DWORD      dwFlags,
  _In_  const SYSTEMTIME *lpTime,
  _In_        LPCWSTR    pwzFormat,
  _Out_       LPWSTR     pwzTimeStr,
  _In_        int        cchTime
);

Parameter

Gebietsschema [in]

Typ: LCID

Gibt das Gebietsschema an, für das die Zeitzeichenfolge formatiert werden soll. Wenn pwzFormatNULL ist, formatiert die Funktion die Zeichenfolge entsprechend dem Zeitformat für dieses Gebietsschema. Wenn pwzFormat nicht NULL ist, verwendet die Funktion das Gebietsschema nur für Informationen, die nicht in der Formatbildzeichenfolge angegeben sind (z. B. die Zeitmarker 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. Sie können eine Kombination der folgenden Werte angeben.

LOCALE_NOUSEROVERRIDE

Wenn festgelegt, formatiert die Funktion die Zeichenfolge mithilfe des Systemstandardzeitformats für das angegebene Gebietsschema. Wenn nicht festgelegt, formatiert die Funktion die Zeichenfolge mithilfe beliebiger Benutzerüberschreibungen auf das Standardzeitformat des Gebietsschemas. Dieses Flag kann nur festgelegt werden, wenn pwzFormatNULL ist.

LOCALE_USE_CP_ACP

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

TIME_NOMINUTESORSECONDS

Verwendet keine Minuten oder Sekunden.

TIME_NOSECONDS

Verwendet keine Sekunden.

TIME_NOTIMEMARKER

Verwendet keine Zeitmarkierung.

TIME_FORCE24HOURFORMAT

Verwendet immer ein 24-Stunden-Zeitformat.

lpTime [in]

Typ: const SYSTEMTIME*

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

pwzFormat [in]

Typ: LPCWSTR

Ein Zeiger auf ein Format, das zum Bilden der Zeitzeichenfolge verwendet werden soll. Wenn pwzFormatNULL ist, verwendet die Funktion das Zeitformat des angegebenen Gebietsschemas. Weitere Informationen finden Sie unter GetTimeFormat .

pwzTimeStr [out]

Typ: LPWSTR

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

cchTime [in]

Typ: int

Die Größe des pwzTimeStr-Puffers in Zeichen. Wenn cchTime null ist, gibt die Funktion die Anzahl der Zeichen zurück, die zum Speichern der formatierten Zeitzeichenfolge erforderlich sind, und der Puffer, auf den pwzTimeStr 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 pwzTimeStr zeigt. Wenn der cchTime-Parameter null ist, ist der Rückgabewert die Anzahl der Zeichen, die zum Speichern der formatierten Zeitzeichenfolge 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

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

GetTimeFormatWrapW muss mithilfe von Ordinal 310 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

GetTimeFormat