StringCchVPrintf_lW, fonction (strsafe.h)

Article
08/26/2023

Écrit les données mises en forme dans la chaîne spécifiée à l’aide d’un pointeur vers une liste d’arguments. La taille de la mémoire tampon de destination est fournie à la fonction pour s’assurer qu’elle n’écrit pas après la fin de cette mémoire tampon.

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

Syntaxe

STRSAFEAPI StringCchVPrintf_lW(
  [out] STRSAFE_LPWSTR                                  pszDest,
  [in]  size_t                                          cchDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
  [in]  _locale_t                                       locale,
  [in]  va_list                                         argList
);

Paramètres

[out] pszDest

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

[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é 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.

[in] argList

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

Valeur retournée

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.

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

Remarques

Pour plus d’informations sur va_lists, consultez les conventions définies dans Stdarg.h.

Le comportement n’est pas défini si les chaînes pointées par pszDest, pszFormat ou des chaînes d’arguments se chevauchent.

Ni pszFormat ni pszDest ne doivent avoir la valeur NULL. Consultez StringCchVPrintf_lEx si vous avez besoin de gérer 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

Notes

L’en-tête strsafe.h définit StringCchVPrintf_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. La combinaison 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.

Configuration requise


Client minimal pris en charge	Windows Vista [applications de bureau \| applications UWP]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	strsafe.h

Partager via