fonction StringCchPrintf_lW (strsafe.h)

Article
11/20/2024

Écrit des données mises en forme dans la chaîne spécifiée. La taille de la mémoire tampon de destination est fournie à la fonction pour s’assurer qu’elle n’écrit pas au-delà de la fin de cette mémoire tampon.

StringCchPrintf_l est similaire à stringCchPrintf, mais inclut un paramètre pour les informations de paramètres régionaux.

Syntaxe

STRSAFEAPI StringCchPrintf_lW(
  [out] STRSAFE_LPWSTR                                  pszDest,
  [in]  size_t                                          cchDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
  [in]  _locale_t                                       locale,
        ...                                             
);

Paramètres

[out] pszDest

Mémoire tampon de destination, qui reçoit la chaîne mise en forme et terminée par null créée à partir de pszFormat et ses arguments.

[in] cchDest

Taille de la mémoire tampon de destination, en caractères. Cette valeur doit être suffisamment grande pour prendre en charge la chaîne mise en forme finale plus 1 pour tenir compte du caractère null de fin. Le nombre maximal de caractères autorisés est STRSAFE_MAX_CCH.

[in] pszFormat

Chaîne de format. Cette chaîne doit être terminée par null. Pour plus d’informations, consultez syntaxe de spécification de format.

[in] locale

Objet de paramètres régionaux. Pour plus d’informations, consultez _create_locale.

...

Arguments à insérer dans la chaîne pszFormat.

Valeur de retour

Cette fonction peut retourner l’une des valeurs suivantes. Il est fortement recommandé d’utiliser les macros SUCCEEDED et FAILED pour tester la valeur de retour de cette fonction.

Retourner le code	Description
S_OK	Il y a eu suffisamment d’espace pour que le résultat soit copié dans pszDest sans troncation, et la mémoire tampon est terminée par null.
STRSAFE_E_INVALID_PARAMETER	La valeur dans cchDest est soit 0 ou supérieure à STRSAFE_MAX_CCH.
STRSAFE_E_INSUFFICIENT_BUFFER	L’opération de copie a échoué en raison d’un espace tampon insuffisant. La mémoire tampon de destination contient une version tronquée et terminée par null du résultat prévu. Dans les situations où la troncation est acceptable, cela peut ne pas nécessairement être considéré comme une condition d’échec.

Remarques

Le comportement n’est pas défini si les chaînes pointées par pszDest, pszFormatou les chaînes d’argument se chevauchent.

Ni pszFormat ni pszDest ne doit être NULL . Consultez StringCchPrintf_lEx si vous avez besoin de la gestion des valeurs de pointeur de chaîne Null.

Pour utiliser cette fonction, vous devez définir la macro suivante dans votre fichier d’en-tête, avant d’inclure StrSafe.h.

#define STRSAFE_LOCALE_FUNCTIONS

Note

L’en-tête strsafe.h définit StringCchPrintf_l en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows Vista [applications de bureau \| Applications UWP]
serveur minimum pris en charge	Windows Server 2008 [applications de bureau \| Applications UWP]
plateforme cible	Windows
d’en-tête	strsafe.h

Partager via