GetDurationFormat-Funktion (winnls.h)

Artikel
03/06/2024

Formatiert eine Zeitdauer als Zeitzeichenfolge für ein durch den Bezeichner angegebenes Gebietsschema.

Hinweis Aus Interoperabilitätsgründen sollte die Anwendung die GetDurationFormatEx-Funktiongegenüber GetDurationFormat vorziehen, da Microsoft zur Verwendung von Gebietsschemanamen anstelle von Gebietsschemabezeichnern für neue Gebietsschemas migriert. Jede Anwendung, die nur unter Windows Vista und höher ausgeführt wird, sollte GetDurationFormatEx verwenden.

Syntax

int GetDurationFormat(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in, optional]  const SYSTEMTIME *lpDuration,
  [in]            ULONGLONG        ullDuration,
  [in, optional]  LPCWSTR          lpFormat,
  [out, optional] LPWSTR           lpDurationStr,
  [in]            int              cchDuration
);

Parameter

[in] Locale

Gebietsschemabezeichner , der das Gebietsschema angibt, für das diese Funktion die Dauer formatiert. Sie können das MAKELCID-Makro verwenden, um einen Gebietsschemabezeichner zu erstellen oder einen der folgenden vordefinierten Werte zu verwenden.

Windows Vista und höher: Die folgenden benutzerdefinierten Gebietsschemabezeichner werden ebenfalls unterstützt.

[in] dwFlags

Flags, die Funktionsoptionen angeben. Wenn lpFormat nicht auf NULL festgelegt ist, muss dieser Parameter auf 0 festgelegt werden. Wenn lpFormat auf NULL festgelegt ist, kann Ihre Anwendung LOCALE_NOUSEROVERRIDE angeben, um die Zeichenfolge mithilfe des Systemstandarddauerformats für das angegebene Gebietsschema zu formatieren.

Vorsicht Die Verwendung von LOCALE_NOUSEROVERRIDE wird dringend abgeraten, da die Benutzereinstellungen deaktiviert werden.

[in, optional] lpDuration

Zeiger auf eine SYSTEMTIME-Struktur , die die zu formatierenden Zeitdauerinformationen enthält. Wenn dieser Zeiger NULL ist, ignoriert die Funktion diesen Parameter und verwendet ullDuration.

[in] ullDuration

64-Bit-Ganzzahl ohne Vorzeichen, die die Anzahl der Intervalle von 100 Nanosekunden in der Dauer darstellt. Wenn sowohl lpDuration als auch ullDuration vorhanden sind, hat lpDuration Vorrang. Wenn lpDuration auf NULL und ullDuration auf 0 festgelegt ist, ist die Dauer 0.

[in, optional] lpFormat

Zeiger auf die Formatzeichenfolge. Ausführliche Informationen finden Sie im lpFormat-Parameter von GetDurationFormatEx.

[out, optional] lpDurationStr

Zeiger auf den Puffer, in dem die Funktion die Dauerzeichenfolge abruft.

Alternativ kann dieser Parameter NULL enthalten, wenn cchDuration auf 0 festgelegt ist. In diesem Fall gibt die Funktion die erforderliche Größe für den Dauerzeichenfolgenpuffer zurück.

[in] cchDuration

Größe des Puffers, der von lpDurationStr. angegeben wird, in Zeichen

Alternativ kann die Anwendung diesen Parameter auf 0 festlegen. In diesem Fall ruft die Funktion NULL in lpDurationStr ab und gibt die erforderliche Größe für den Dauerzeichenfolgenpuffer zurück.

Rückgabewert

Gibt die Anzahl der im Puffer abgerufenen Zeichen zurück, die bei erfolgreicher Ausführung von lpDurationStr angegeben wurden. Wenn lpDurationStr auf NULL und cchDuration auf 0 festgelegt ist, gibt die Funktion die erforderliche Größe für den Dauerzeichenfolgenpuffer zurück, einschließlich des NULL-Abschlusszeichens. Wenn beispielsweise 10 Zeichen in den Puffer geschrieben werden, gibt die Funktion 11 zurück, um das beendende NULL-Zeichen einzuschließen.

Die 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_INSUFFICIENT_BUFFER. Eine angegebene Puffergröße war nicht groß genug, oder sie wurde fälschlicherweise auf NULL festgelegt.
ERROR_INVALID_PARAMETER. Jeder der Parameterwerte war ungültig.

Hinweise

Weitere Informationen finden Sie unter Hinweise zu GetDurationFormatEx.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winnls.h (einschließlich Windows.h)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll