GetCalendarDateFormatEx, fonction

Action déconseillée. Récupère une chaîne de date correctement mise en forme pour les paramètres régionaux spécifiés à l’aide de la date et du calendrier spécifiés. L’utilisateur peut spécifier le format de date courte, le format de date long, le format mois de l’année ou un modèle de format personnalisé.

Syntaxe

BOOL GetCalendarDateFormatEx(
  _In_        LPCWSTR       lpszLocale,
  _In_        DWORD         dwFlags,
  _In_  const LPCALDATETIME lpCalDateTime,
  _In_        LPCWSTR       lpFormat,
  _Out_       LPWSTR        lpDateStr,
  _In_        int           cchDate
);

Paramètres

lpszLocale [in]

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

• LOCALE_NAME_INVARIANT
• LOCALE_NAME_SYSTEM_DEFAULT
• LOCALE_NAME_USER_DEFAULT

dwFlags [in]

Indicateurs spécifiant les options de format de date. Si lpFormat n’est pas défini sur NULL, ce paramètre doit avoir la valeur 0. Si lpFormat a la valeur NULL, l’application peut spécifier une combinaison des valeurs suivantes et LOCALE_NOUSEROVERRIDE.

Valeur	Signification
DATE_SHORTDATE	Utilisez le format de date court. Il s’agit de la valeur par défaut. Cette valeur ne peut pas être utilisée avec DATE_LONGDATE ou DATE_YEARMONTH.
DATE_LONGDATE	Utilisez le format de date long. Cette valeur ne peut pas être utilisée avec DATE_SHORTDATE ou DATE_YEARMONTH.
DATE_YEARMONTH	Utilisez le format année/mois. Cette valeur ne peut pas être utilisée avec DATE_SHORTDATE ou DATE_LONGDATE.
DATE_LTRREADING	Ajoutez des marques pour la disposition de lecture de gauche à droite. Cette valeur ne peut pas être utilisée avec DATE_RTLREADING.
DATE_RTLREADING	Ajoutez des marques pour la disposition de lecture de droite à gauche. Cette valeur ne peut pas être utilisée avec DATE_LTRREADING

 

lpCalDateTime [in]

Pointeur vers une structure CALDATETIME qui contient les informations de date et de calendrier à mettre en forme.

lpFormat [in]

Pointeur vers une chaîne d’image de format utilisée pour former la chaîne de date. Les valeurs possibles pour la chaîne d’image de format sont définies dans Jour, Mois, Année et Images au format Era.

La chaîne d’image de format doit être terminée par null. La fonction utilise les paramètres régionaux uniquement pour les informations qui ne sont pas spécifiées dans la chaîne d’image de format, par exemple, les noms des jours et des mois pour les paramètres régionaux. L’application définit ce paramètre sur NULL si la fonction doit utiliser le format de date des paramètres régionaux spécifiés.

lpDateStr [out]

Pointeur vers une mémoire tampon dans laquelle cette fonction reçoit la chaîne de date mise en forme.

cchDate [in]

Taille, en caractères, de la mémoire tampon lpDateStr . L’application peut également définir ce paramètre sur 0. Dans ce cas, la fonction retourne le nombre de caractères requis pour contenir la chaîne de date mise en forme, et le paramètre lpDateStr n’est pas utilisé.

Valeur retournée

Retourne le nombre de caractères écrits dans la mémoire tampon lpDateStr en cas de réussite. Si le paramètre cchDate a la valeur 0, la fonction retourne le nombre de caractères requis pour contenir la chaîne de date mise en forme, y compris le caractère null de fin.

Cette 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_DATE_OUT_OF_RANGE. La date spécifiée était hors de la plage.
• 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.

Notes

La date la plus ancienne prise en charge par cette fonction est le 1er janvier 1601.

Cette fonction n’a pas de fichier d’en-tête ou de fichier de bibliothèque associé. L’application peut appeler LoadLibrary avec le nom de dll (Kernel32.dll) pour obtenir un handle de module. Il peut ensuite appeler GetProcAddress avec ce handle de module et le nom de cette fonction pour obtenir l’adresse de fonction.

Spécifications

Voir aussi

Prise en charge des langues nationales

Fonctions de prise en charge des langues nationales

Images au format Jour, Mois, Année et Ère

NLS : Exemple d’API basées sur le nom

EnumDateFormatsExEx

GetDateFormat

GetDateFormatEx

CALDATETIME