Fonction StringCchPrintfExW (strsafe.h)

  • Article

É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.

StringCchPrintfEx ajoute aux fonctionnalités de StringCchPrintf en renvoyant un pointeur vers la fin de la chaîne de destination, ainsi que le nombre de caractères inutilisés dans cette chaîne. Des indicateurs peuvent également être passés à la fonction pour un contrôle supplémentaire.

StringCchPrintfEx remplace les fonctions suivantes :

Syntaxe

STRSAFEAPI StringCchPrintfExW(
  [out]           STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cchDest,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags,
  [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.

[out, optional] ppszDestEnd

Type : LPTSTR*

Adresse d’un pointeur vers la fin de pszDest. Si ppszDestEnd n’a pas la valeur NULL et que des données sont copiées dans la mémoire tampon de destination, cela pointe vers le caractère null de fin à la fin de la chaîne.

[out, optional] pcchRemaining

Type : size_t*

Nombre de caractères inutilisés dans pszDest, y compris le caractère null de fin. Si pcchRemaining a la valeur NULL, le nombre n’est pas conservé ou retourné.

[in] dwFlags

Type : DWORD

Une ou plusieurs des valeurs suivantes.

Valeur Signification
STRSAFE_FILL_BEHIND_NULL
0x00000200
 Si la fonction réussit, l’octet inférieur de dwFlags (0) est utilisé pour remplir la partie non initialisée de pszDest après le caractère null de fin.
STRSAFE_IGNORE_NULLS
0x00000100
 Traitez les pointeurs de chaîne NULL comme des chaînes vides (TEXT(«  »)).
STRSAFE_FILL_ON_FAILURE
0x00000400
 Si la fonction échoue, l’octet faible de dwFlags (0) est utilisé pour remplir la mémoire tampon pszDest entière, et la mémoire tampon est terminée par null. En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne tronquée retournée est remplacée.
STRSAFE_NULL_ON_FAILURE
0x00000800
 Si la fonction échoue, pszDest est défini sur une chaîne vide (TEXT(«  »)). En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne tronquée est remplacée.
STRSAFE_NO_TRUNCATION
0x00001000
 Comme dans le cas de STRSAFE_NULL_ON_FAILURE, si la fonction échoue, pszDest est défini sur une chaîne vide (TEXT(«  »)). En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne tronquée est remplacée.

[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, ou la mémoire tampon de destination est déjà pleine.
STRSAFE_E_INSUFFICIENT_BUFFER
 L’opération de copie a échoué en raison d’un espace tampon insuffisant. Selon la valeur de dwFlags, la mémoire tampon de destination peut contenir 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, StringCchPrintfEx 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. StringCchPrintfEx 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 , sauf si l’indicateur STRSAFE_IGNORE_NULLS est spécifié, auquel cas les deux peuvent avoir la valeur NULL. Toutefois, une erreur due à un espace insuffisant peut toujours être retournée même si les valeurs NULL sont ignorées.

StringCchPrintfEx 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" StringCchPrintfExA
TCHAR TEXT(« string ») StringCchPrintfEx
WCHAR L"string » StringCchPrintfExW
 

Notes

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

StringCbPrintfEx

StringCchPrintf

StringCchVPrintfEx