Fonction StringCbVPrintfExW (strsafe.h)
Écrit des 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 garantir qu’elle n’écrit pas au-delà de la fin de cette mémoire tampon.
StringCbVPrintfEx ajoute aux fonctionnalités de StringCbVPrintf en retournant un pointeur vers la fin de la chaîne de destination, ainsi que le nombre d’octets inutilisés dans cette chaîne. Des indicateurs peuvent également être passés à la fonction pour un contrôle supplémentaire.
StringCbVPrintfEx remplace les fonctions suivantes :
Syntaxe
STRSAFEAPI StringCbVPrintfExW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cbDest,
[out, optional] STRSAFE_LPWSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags,
[in] STRSAFE_LPCWSTR pszFormat,
[in] va_list argList
);
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 d’argList.
[in] cbDest
Type : size_t
Taille de la mémoire tampon de destination, en octets. Cette valeur doit être suffisamment grande pour prendre en charge la chaîne mise en forme finale plus le caractère null de fin. Le nombre maximal d’octets autorisé est STRSAFE_MAX_CCH * sizeof(TCHAR).
[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] pcbRemaining
Type : size_t*
Nombre d’octets inutilisés dans pszDest, y compris ceux utilisés pour le caractère null de fin. Si pcbRemaining a la valeur NULL, le nombre n’est pas conservé ou retourné.
[in] dwFlags
Type : DWORD
Une ou plusieurs des valeurs suivantes.
[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.
[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 vivement recommandé d’utiliser les macros SUCCEEDED et FAILED pour tester la valeur de retour de cette fonction.
| Code de retour | Description |
|---|---|
|
Il y a suffisamment d’espace pour que le résultat soit copié dans pszDest sans troncation, et la mémoire tampon est terminée par null. |
|
La valeur dans cbDest est 0 ou supérieure à STRSAFE_MAX_CCH * sizeof(TCHAR), ou la mémoire tampon de destination est déjà pleine.
|
|
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
StringCbVPrintfEx 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. StringCbVPrintfEx met toujours fin à 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 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.
StringCbVPrintfEx 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, comme indiqué dans le tableau suivant.
| String, type de données | Littéral de chaîne | Fonction |
|---|---|---|
| char | "chaîne" | StringCbVPrintfExA |
| TCHAR | TEXT(« string ») | StringCbVPrintfEx |
| WCHAR | L"string » | StringCbVPrintfExW |
Notes
L’en-tête strsafe.h définit StringCbVPrintfEx 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
| 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