Fonction RtlStringCchPrintfA (ntstrsafe.h)

Article
05/03/2024

Les fonctions RtlStringCchPrintfW et RtlStringCchPrintfA créent une chaîne de texte comptant des caractères, avec une mise en forme basée sur les informations de mise en forme fournies.

Syntaxe

NTSTRSAFEDDI RtlStringCchPrintfA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  NTSTRSAFE_PCSTR pszFormat,
        ...             
);

Paramètres

[out] pszDest

Pointeur vers une mémoire tampon fournie par l’appelant qui reçoit une chaîne mise en forme et terminée par null. La fonction crée cette chaîne à partir de la chaîne de mise en forme fournie par pszFormat et de la liste d’arguments de la fonction.

[in] cchDest

Taille de la mémoire tampon de destination, en caractères. La mémoire tampon doit être suffisamment grande pour contenir la chaîne mise en forme plus le caractère null de fin. Le nombre maximal de caractères autorisé est NTSTRSAFE_MAX_CCH.

[in] pszFormat

Pointeur vers une chaîne de texte terminée par null qui contient des directives de mise en forme de style printf.

...

Liste d’arguments interprétés par la fonction, en fonction des directives de mise en forme contenues dans la chaîne pszFormat .

Valeur retournée

La fonction retourne l’une des valeurs NTSTATUS répertoriées dans le tableau suivant. Pour plus d’informations sur le test des valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

Code de retour	Description
STATUS_SUCCESS	Ce succès status signifie que les données sources étaient présentes, que la chaîne a été créée sans troncation et que la mémoire tampon de destination résultante est terminée par null.
STATUS_BUFFER_OVERFLOW	Cet avertissement status signifie que l’opération ne s’est pas terminée en raison d’un espace insuffisant dans la mémoire tampon de destination. La mémoire tampon de destination contient une version tronquée de la chaîne de sortie.
STATUS_INVALID_PARAMETER	Cette erreur status signifie que la fonction a reçu un paramètre d’entrée non valide. Pour plus d’informations, consultez le paragraphe suivant. La fonction retourne la valeur STATUS_INVALID_PARAMETER lorsque : La valeur dans cchDest est supérieure à la taille maximale de la mémoire tampon. La mémoire tampon de destination était déjà pleine. Un pointeur NULL était présent. La longueur de la mémoire tampon de destination était égale à zéro, mais une chaîne source de longueur différente de zéro était présente.

Code de retour

Description

STATUS_SUCCESS

Ce succès status signifie que les données sources étaient présentes, que la chaîne a été créée sans troncation et que la mémoire tampon de destination résultante est terminée par null.

STATUS_BUFFER_OVERFLOW

Cet avertissement status signifie que l’opération ne s’est pas terminée en raison d’un espace insuffisant dans la mémoire tampon de destination. La mémoire tampon de destination contient une version tronquée de la chaîne de sortie.

STATUS_INVALID_PARAMETER

Cette erreur status signifie que la fonction a reçu un paramètre d’entrée non valide. Pour plus d’informations, consultez le paragraphe suivant.

La fonction retourne la valeur STATUS_INVALID_PARAMETER lorsque :

La valeur dans cchDest est supérieure à la taille maximale de la mémoire tampon.
La mémoire tampon de destination était déjà pleine.
Un pointeur NULL était présent.
La longueur de la mémoire tampon de destination était égale à zéro, mais une chaîne source de longueur différente de zéro était présente.

Remarques

RtlStringCchPrintfW et RtlStringCchPrintfA doivent être utilisés à la place des fonctions suivantes :

sprintf
swprintf
_snprintf
_snwprintf

Toutes ces fonctions acceptent une chaîne de format et une liste d’arguments et retournent une chaîne mise en forme. RtlStringCchPrintfW et RtlStringCchPrintfA acceptent la taille, en caractères, de la mémoire tampon de destination pour s’assurer que les fonctions n’écrivent pas au-delà de la fin de la mémoire tampon.

Utilisez RtlStringCchPrintfW pour gérer les chaînes Unicode et RtlStringCchPrintfA pour gérer les chaînes ANSI. Le formulaire que vous utilisez dépend de vos données.

Type de données String	Littéral de chaîne	Fonction
WCHAR	L"string »	RtlStringCchPrintfW
char	"chaîne"	RtlStringCchPrintfA

Si pszDest et pszFormat pointent vers des chaînes qui se chevauchent ou si des chaînes d’argument se chevauchent, le comportement de la fonction n’est pas défini.

Ni pszFormat ni pszDest ne peuvent avoir la valeur NULL. Si vous devez gérer les valeurs de pointeur de chaîne NULL , utilisez RtlStringCchPrintfEx.

Exemples

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

WCHAR pszDest[30]; 
size_t cchDest = 30;

LPCWSTR pszFormat = L"%s %d + %d = %d.";
WCHAR* pszTxt = L"The answer is";

NTSTATUS status = 
    RtlStringCchPrintfW(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);

La chaîne résultante est « La réponse est 1 + 2 = 3 ». Il est contenu dans la mémoire tampon au niveau pszDest.

Pour plus d’informations sur les fonctions de chaîne sécurisée, consultez Utilisation des fonctions de chaîne sécurisée.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible à partir de Windows XP avec Service Pack 1 (SP1).
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	ntstrsafe.h (inclure Ntstrsafe.h)
Bibliothèque	Ntstrsafe.lib
IRQL	Toutes les chaînes si manipulées résident toujours dans la mémoire, sinon PASSIVE_LEVEL

Voir aussi

RtlStringCbPrintf

RtlStringCchPrintfEx

RtlStringCchVPrintf

Partager via