GetCalendarInfoEx-Funktion (winnls.h)

  • Artikel

Ruft Informationen zu einem Kalender für ein gebietsschema ab, das mit dem Namen angegeben ist.

Hinweis Die Anwendung sollte diese Funktion vorzugsauf GetCalendarInfo aufrufen, wenn sie nur unter Windows Vista und höher ausgeführt werden soll.

 
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

int GetCalendarInfoEx(
  [in, optional]  LPCWSTR lpLocaleName,
  [in]            CALID   Calendar,
  [in, optional]  LPCWSTR lpReserved,
  [in]            CALTYPE CalType,
  [out, optional] LPWSTR  lpCalData,
  [in]            int     cchData,
  [out, optional] LPDWORD lpValue
);

Parameter

[in, optional] lpLocaleName

Zeiger auf einen Gebietsschemanamen oder einen der folgenden vordefinierten Werte.

[in] Calendar

Kalenderbezeichner.

[in, optional] lpReserved

Reserviert; muss NULL sein.

[in] CalType

Art der abzurufenden Informationen. Weitere Informationen finden Sie unter Kalendertypinformationen.

HinweisGetCalendarInfoEx gibt nur eine Zeichenfolge zurück, wenn dieser Parameter CAL_IYEAROFFSETRANGE oder CAL_SERASTRING angibt. In beiden Fällen wird die aktuelle Ära zurückgegeben.
 
Für CAL_NOUSEROVERRIDE ignoriert die Funktion alle von SetCalendarInfo festgelegten Werte und verwendet die Datenbankeinstellungen für das aktuelle Systemstandardgebietsschema. Dieser Typ ist nur in der Kombination CAL_NOUSEROVERRIDE | CAL_ITWODIGITYEARMAX. CAL_ITWODIGITYEARMAX ist der einzige Wert, der von SetCalendarInfo festgelegt werden kann.

[out, optional] lpCalData

Zeiger auf einen Puffer, in dem diese Funktion die angeforderten Daten als Zeichenfolge abruft. Wenn CAL_RETURN_NUMBER in CalType angegeben ist, muss dieser Parameter NULL abrufen.

[in] cchData

Größe des lpCalData-Puffers in Zeichen. Die Anwendung kann diesen Parameter auf 0 festlegen, um die erforderliche Größe für den Kalenderdatenpuffer zurückzugeben. In diesem Fall wird der lpCalData-Parameter nicht verwendet. Wenn CAL_RETURN_NUMBER für CalType angegeben ist, muss der Wert von cchData 0 sein.

[out, optional] lpValue

Zeiger auf eine Variable, die die angeforderten Daten als Zahl empfängt. Wenn CAL_RETURN_NUMBER in CalType angegeben ist, darf lpValue nicht NULL sein. Wenn CAL_RETURN_NUMBER in CalType nicht angegeben ist, muss lpValueNULL sein.

Rückgabewert

Gibt die Anzahl der im lpCalData-Puffer abgerufenen Zeichen zurück, wenn dies erfolgreich war. Wenn die Funktion erfolgreich ist, wird cchData auf 0 festgelegt, und CAL_RETURN_NUMBER nicht angegeben ist, ist der Rückgabewert die Größe des Puffers, der zum Aufnehmen der Gebietsschemainformationen erforderlich ist. Wenn die Funktion erfolgreich ist, wird cchData auf 0 festgelegt, und CAL_RETURN_NUMBER angegeben wird, ist der Rückgabewert die Größe des Werts, der in den lpValue-Parameter geschrieben wurde. Diese Größe ist immer 2.

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_FLAGS. Die für Flags angegebenen Werte waren ungültig.
  • ERROR_INVALID_PARAMETER. Jeder der Parameterwerte war ungültig.

Hinweise

Hinweis Diese API wird aktualisiert, um die Änderung der japanischen Ära vom Mai 2019 zu unterstützen. Wenn Ihre Anwendung den japanischen Kalender unterstützt, sollten Sie überprüfen, ob sie die neue Ära ordnungsgemäß verarbeitet. Weitere Informationen finden Sie unter Vorbereiten der Anwendung für die Änderung der japanischen Ära .
 
Ab Windows 8: Wenn Ihre App Sprachtags aus dem Windows.Globalization-Namespace an diese Funktion übergibt, müssen die Tags zuerst konvertiert werden , indem ResolveLocaleName aufgerufen wird.

Anforderungen

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

Siehe auch

Kalendertypinformationen

GetCalendarInfo

Unterstützung für nationale Sprachen

Nationale Sprachunterstützungsfunktionen

SetCalendarInfo