StringCbPrintfA, fonction (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 s’assurer qu’elle n’écrit pas après la fin de cette mémoire tampon.

StringCbPrintf remplace les fonctions suivantes :

Syntaxe

STRSAFEAPI StringCbPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszFormat,
        ...            
);

Paramètres

[out] pszDest

Type : LPSTR

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

[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és est STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszFormat

Type : LPCSTR

Chaîne de format. Cette chaîne doit être terminée par null. Pour plus d’informations, consultez Syntaxe de spécification de format.

...

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 null.
STRSAFE_E_INVALID_PARAMETER
 La valeur dans cbDest est 0 ou supérieure à STRSAFE_MAX_CCH * sizeof(TCHAR).
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

Par rapport aux fonctions qu’il remplace, StringCbPrintf 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. StringCbPrintf termine toujours 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 par pszDest, pszFormat ou des chaînes d’arguments se chevauchent.

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

StringCbPrintf 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" StringCbPrintfA
TCHAR TEXT(« string ») StringCbPrintf
WCHAR L"string » StringCbPrintfW
 

Exemples

L’exemple suivant montre une utilisation de base de StringCbPrintf, à l’aide de quatre arguments.

int const arraysize = 30;
TCHAR pszDest[arraysize]; 
size_t cbDest = arraysize * sizeof(TCHAR);

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

HRESULT hr = StringCbPrintf(pszDest, cbDest, 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 StringCbPrintf 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

   
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

StringCbVPrintf

StringCchPrintf