Fonction RtlStringCbVPrintfA (ntstrsafe.h)
Les fonctions RtlStringCbVPrintfW et RtlStringCbVPrintfA créent une chaîne de texte comptée en octets, avec une mise en forme basée sur les informations de mise en forme fournies.
Syntaxe
NTSTRSAFEDDI RtlStringCbVPrintfA(
[out] NTSTRSAFE_PSTR pszDest,
[in] size_t cbDest,
[in] NTSTRSAFE_PCSTR pszFormat,
[in] va_list argList
);
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 des arguments fournis par argList.
[in] cbDest
Taille de la mémoire tampon de destination, en octets. La mémoire tampon doit être suffisamment grande pour contenir la chaîne mise en forme plus le caractère null de fin.
Pour les chaînes Unicode, le nombre maximal d’octets est NTSTRSAFE_MAX_CCH * sizeof(WCHAR).
Pour les chaînes ANSI, le nombre maximal d’octets est NTSTRSAFE_MAX_CCH * sizeof(char).
[in] pszFormat
Pointeur vers une chaîne de texte terminée par null qui contient des directives de mise en forme de style printf.
[in] argList
Liste d’arguments de type va_list. Les arguments contenus dans la liste d’arguments seront interprétés à l’aide de la chaîne de mise en forme fournie par 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 de sortie 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 créée. |
|
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
RtlStringCbVPrintfW et RtlStringCbVPrintfA doivent être utilisés à la place des fonctions suivantes :
- vsprintf
- vswprintf
- _vsnprintf
- _vsnwprintf
Pour plus d’informations sur les listes d’arguments typées va_list, consultez la documentation Microsoft Windows SDK.
Utilisez RtlStringCbVPrintfW pour gérer les chaînes Unicode et RtlStringCbVPrintfA pour gérer les chaînes ANSI. Le formulaire que vous utilisez dépend de vos données, comme indiqué dans le tableau suivant.
Type de données String | Littéral de chaîne | Fonction |
---|---|---|
WCHAR | L"string » | RtlStringCbVPrintfW |
char | "chaîne" | RtlStringCbVPrintfA |
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 doivent avoir la valeur NULL. Si vous devez gérer les valeurs de pointeur de chaîne NULL , utilisez RtlStringCbVPrintfEx.
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 |