Fonction RtlStringCchPrintfW (ntstrsafe.h)
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 RtlStringCchPrintfW(
[out] NTSTRSAFE_PWSTR pszDest,
[in] size_t cchDest,
[in] NTSTRSAFE_PCWSTR pszFormat,
...
);
Paramètres
[out] pszDest
Pointeur vers une mémoire tampon fournie par l’appelant qui reçoit une chaîne mise en forme 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 la façon de tester les valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.
Code de retour | Description |
---|---|
|
Cette réussite 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 un caractère Null. |
|
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. |
|
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 :
|
Remarques
RtlStringCchPrintfW et RtlStringCchPrintfA doivent être utilisés à la place des fonctions suivantes :
- sprintf
- swprintf
- _snprintf
- _snwprintf
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’arguments se chevauchent, le comportement de la fonction n’est pas défini.
Ni pszFormat ni pszDest ne peuvent être 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 à l’emplacement pszDest.
Pour plus d’informations sur les fonctions de chaîne sécurisée, consultez Utilisation de 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 (include Ntstrsafe.h) |
Bibliothèque | Ntstrsafe.lib |
IRQL | Toutes les chaînes si manipulées résident toujours en mémoire, sinon PASSIVE_LEVEL |