GetCurrencyFormatEx, fonction (winnls.h)

  • Article

Met en forme une chaîne numérique en tant que chaîne monétaire pour un paramètre régional spécifié par nom.

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

 
Note Cette fonction peut mettre en forme 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 GetCurrencyFormatEx(
  [in, optional]  LPCWSTR            lpLocaleName,
  [in]            DWORD              dwFlags,
  [in]            LPCWSTR            lpValue,
  [in, optional]  const CURRENCYFMTW *lpFormat,
  [out, optional] LPWSTR             lpCurrencyStr,
  [in]            int                cchCurrency
);

Paramètres

[in, optional] lpLocaleName

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

[in] dwFlags

Indicateurs contrôlant le fonctionnement de la fonction. L’application doit définir ce paramètre sur 0 si lpFormat n’est pas défini sur NULL. Dans ce cas, la fonction met en forme la chaîne à l’aide de l’utilisateur remplace par le format monétaire par défaut pour les paramètres régionaux. Si lpFormat a la valeur NULL, l’application peut spécifier LOCALE_NOUSEROVERRIDE pour mettre en forme la chaîne à l’aide du format monétaire par défaut du système pour les paramètres régionaux spécifiés.

Attention L’utilisation de LOCALE_NOUSEROVERRIDE est fortement déconseillée, car elle désactive les préférences utilisateur.
 

[in] lpValue

Pointeur vers une chaîne terminée par null contenant la chaîne numérique à mettre en forme. Cette chaîne ne peut contenir que les caractères suivants. Tous les autres caractères ne sont pas valides. La fonction retourne une erreur si la chaîne s’écarte de ces règles.

  • Caractères « 0 » à « 9 »
  • Une décimale (point) si le nombre est une valeur à virgule flottante
  • Signe moins dans la première position de caractère si le nombre est une valeur négative

[in, optional] lpFormat

Pointeur vers une structure CURRENCYFMT qui contient des informations de mise en forme monétaire. Tous les membres de la structure doivent contenir les valeurs appropriées. L’application peut définir ce paramètre sur NULL si la fonction doit utiliser le format monétaire des paramètres régionaux spécifiés. Si ce paramètre n’est pas défini sur NULL, la fonction utilise les paramètres régionaux spécifiés uniquement pour la mise en forme des informations non spécifiées dans la structure CURRENCYFMT , par exemple, la valeur de chaîne pour le signe négatif utilisé par les paramètres régionaux.

[out, optional] lpCurrencyStr

Pointeur vers une mémoire tampon dans laquelle cette fonction récupère la chaîne monétaire mise en forme.

[in] cchCurrency

Taille, en caractères, de la mémoire tampon lpCurrencyStr . L’application peut définir ce paramètre sur 0 pour renvoyer la taille de la mémoire tampon requise pour contenir la chaîne monétaire mise en forme. Dans ce cas, la mémoire tampon indiquée par lpCurrencyStr n’est pas utilisée.

Valeur retournée

Retourne le nombre de caractères récupérés dans la mémoire tampon indiquée par lpCurrencyStr en cas de réussite. Si le paramètre cchCurrency est 0, la fonction retourne la taille de la mémoire tampon requise pour contenir la chaîne monétaire mise en forme, y compris un caractère null de fin.

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

À 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 2000 Professionnel [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

CURRENCYFMT

GetCurrencyFormat

GetNumberFormatEx

Prise en charge des langues nationales

Fonctions de prise en charge des langues nationales