StringCchVPrintfA, fonction (strsafe.h)

Article
03/02/2024

É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 remplace les fonctions suivantes :

Syntaxe

STRSAFEAPI StringCchVPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_LPCSTR pszFormat,
  [in]  va_list        argList
);

Paramètres

[out] pszDest

Type : LPTSTR

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

Type : size_t

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

Type : LPCTSTR

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] argList

Type : va_list

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

Valeur retournée

Type : HRESULT

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.

Notez que cette fonction retourne une valeur HRESULT , contrairement aux fonctions qu’elle remplace.

Remarques

StringCchVPrintf fournit un traitement supplémentaire pour une gestion appropriée de la mémoire tampon dans votre code. Une gestion médiocre de la mémoire tampon est impliquée dans de nombreux problèmes de sécurité qui impliquent des dépassements de mémoire tampon. StringCchVPrintf termine toujours une mémoire tampon de destination de longueur différente de zéro.

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 StringCchVPrintfEx si vous avez besoin de gérer des valeurs de pointeur de chaîne null.

StringCchVPrintf peut être utilisé dans sa forme générique ou dans ses formes plus spécifiques. Le type de données de la chaîne détermine la forme de cette fonction que vous devez utiliser, comme indiqué dans le tableau suivant.

String, type de données	Littéral de chaîne	Fonction
char	"chaîne"	StringCchVPrintfA
TCHAR	TEXT(« string »)	StringCchVPrintf
WCHAR	L"string »	StringCchVPrintfW

Notes

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

Condition requise	Valeur
Client minimal pris en charge	Windows XP avec SP2 [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2003 avec SP1 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	strsafe.h

Voir aussi

Référence

StringCbVPrintf

StringCchPrintf

StringCchVPrintfEx