Fonction StringCchPrintfW (strsafe.h)

Article
08/26/2023

Écrit les 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 garantir qu’elle n’écrit pas au-delà de la fin de cette mémoire tampon.

StringCchPrintf remplace les fonctions suivantes :

Syntaxe

STRSAFEAPI StringCchPrintfW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_LPCWSTR pszFormat,
        ...             
);

Paramètres

[out] pszDest

Type : LPTSTR

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 de ses arguments.

[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 FormatEr la syntaxe de spécification.

...

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

Valeur retournée

Type : HRESULT

Cette fonction peut retourner l’une des valeurs suivantes. Il est vivement 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 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 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 de défaillance.

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

Remarques

Par rapport aux fonctions qu’il remplace, StringCchPrintf 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. StringCchPrintf met toujours fin à une mémoire tampon de destination de longueur différente de zéro.

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

Ni pszFormat ni pszDest ne doivent avoir la valeur NULL. Consultez StringCchPrintfEx si vous avez besoin de gérer des valeurs de pointeur de chaîne null.

StringCchPrintf peut être utilisé sous 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.

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

Exemples

L’exemple suivant montre une utilisation simple de StringCchPrintf, à l’aide de quatre arguments.

TCHAR pszDest[30]; 
size_t cchDest = 30;

LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");

HRESULT hr = StringCchPrintf(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);

// The resultant string at pszDest is "The answer is 1 + 2 = 3."

Notes

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

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

StringCbPrintf

StringCchPrintfEx

StringCchVPrintf

Partager via