GetCalendarInfoEx, fonction (winnls.h)

  • Article

Récupère des informations sur un calendrier pour un paramètre régional spécifié par nom.

Note L’application doit appeler cette fonction de préférence à GetCalendarInfo si elle est conçue pour s’exécuter uniquement sur Windows Vista et versions ultérieures.

 
Note Cette fonction peut récupérer des données qui changent d’une version à l’autre, par exemple en raison d’un paramètre régional personnalisé. Si votre application doit conserver ou transmettre des données, consultez Utilisation des données de paramètres régionaux persistants.
 

Syntaxe

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
);

Paramètres

[in, optional] lpLocaleName

Pointeur vers un nom de paramètres régionaux ou l’une des valeurs prédéfinies suivantes.

[in] Calendar

Identificateur de calendrier.

[in, optional] lpReserved

Réservés au; doit avoir la valeur NULL.

[in] CalType

Type d’informations à récupérer. Pour plus d’informations, consultez Informations sur le type de calendrier.

RemarqueGetCalendarInfoEx retourne une seule chaîne si ce paramètre spécifie CAL_IYEAROFFSETRANGE ou CAL_SERASTRING. Dans les deux cas, l’ère actuelle est retournée.
 
Par CAL_NOUSEROVERRIDE, la fonction ignore toute valeur définie par SetCalendarInfo et utilise les paramètres de base de données pour les paramètres régionaux système par défaut actuels. Ce type n’est pertinent que dans la combinaison CAL_NOUSEROVERRIDE | CAL_ITWODIGITYEARMAX. CAL_ITWODIGITYEARMAX est la seule valeur qui peut être définie par SetCalendarInfo.

[out, optional] lpCalData

Pointeur vers une mémoire tampon dans laquelle cette fonction récupère les données demandées sous forme de chaîne. Si CAL_RETURN_NUMBER est spécifié dans CalType, ce paramètre doit récupérer null.

[in] cchData

Taille, en caractères, de la mémoire tampon lpCalData . L’application peut définir ce paramètre sur 0 pour renvoyer la taille requise pour la mémoire tampon de données de calendrier. Dans ce cas, le paramètre lpCalData n’est pas utilisé. Si CAL_RETURN_NUMBER est spécifié pour CalType, la valeur de cchData doit être 0.

[out, optional] lpValue

Pointeur vers une variable qui reçoit les données demandées sous forme de nombre. Si CAL_RETURN_NUMBER est spécifié dans CalType, lpValue ne doit pas avoir la valeur NULL. Si CAL_RETURN_NUMBER n’est pas spécifié dans CalType, lpValue doit avoir la valeur NULL.

Valeur retournée

Retourne le nombre de caractères récupérés dans la mémoire tampon lpCalData en cas de réussite. Si la fonction réussit, cchData est défini sur 0 et CAL_RETURN_NUMBER n’est pas spécifié, la valeur de retour correspond à la taille de la mémoire tampon requise pour contenir les informations de paramètres régionaux. Si la fonction réussit, cchData est défini sur 0 et CAL_RETURN_NUMBER est spécifié, la valeur de retour correspond à la taille de la valeur écrite dans le paramètre lpValue . Cette taille est toujours 2.

La fonction retourne 0 si elle ne réussit pas. Pour obtenir des informations d’erreur étendues, l’application peut appeler GetLastError, qui peut retourner l’un des codes d’erreur suivants :

  • ERROR_INSUFFICIENT_BUFFER. Une taille de mémoire tampon fournie n’était pas assez grande ou elle a été incorrectement définie sur NULL.
  • ERROR_INVALID_FLAGS. Les valeurs fournies pour les indicateurs n’étaient pas valides.
  • ERROR_INVALID_PARAMETER. L’une des valeurs de paramètre n’était pas valide.

Remarques

Note Cette API est mise à jour pour prendre en charge le changement d’ère japonaise de mai 2019. Si votre application prend en charge le calendrier japonais, vous devez vérifier qu’elle gère correctement la nouvelle ère. Pour plus d’informations, consultez Préparer votre application pour le changement d’ère japonaise .
 
À partir de Windows 8 : Si votre application transmet des balises de langue à cette fonction à partir de l’espace de noms Windows.Globalization , elle doit d’abord convertir les balises en appelant ResolveLocaleName.

Configuration requise

   
Client minimal pris en charge Windows Vista [applications de bureau | applications UWP]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau | Applications UWP]
Plateforme cible Windows
En-tête winnls.h (inclure Windows.h)
Bibliothèque Kernel32.lib
DLL Kernel32.dll

Voir aussi

Informations sur le type de calendrier

GetCalendarInfo

Prise en charge des langues nationales

Fonctions de prise en charge des langues nationales

SetCalendarInfo