Fonction RtlStringCbVPrintfExW (ntstrsafe.h)
Les fonctions RtlStringCbVPrintfExW et RtlStringCbVPrintfExA 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 RtlStringCbVPrintfExW(
[out, optional] NTSTRSAFE_PWSTR pszDest,
[in] size_t cbDest,
[out, optional] NTSTRSAFE_PWSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags,
[in, optional] NTSTRSAFE_PCWSTR pszFormat,
[in] va_list argList
);
Paramètres
[out, optional] 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. Le pointeur pszDest peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.
[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).
Si pszDest a la valeur NULL, cbDest doit être égal à zéro.
[out, optional] ppszDestEnd
Si l’appelant fournit un pointeur d’adresse non NULL , une fois l’opération terminée, la fonction charge cette adresse avec un pointeur vers le terminateur de chaîne null résultant de la mémoire tampon de destination.
[out, optional] pcbRemaining
Si l’appelant fournit un pointeur d’adresse non NULL , la fonction charge l’adresse avec le nombre d’octets inutilisés qui se trouvent dans la mémoire tampon pointée par pszDest, y compris les octets utilisés pour le caractère null de fin.
[in] dwFlags
Un ou plusieurs indicateurs et, éventuellement, un octet de remplissage. Les indicateurs sont définis comme suit :
[in, optional] pszFormat
Pointeur vers une chaîne de texte terminée par null qui contient des directives de mise en forme de style printf. Le pointeur pszFormat peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.
[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. Si STRSAFE_NO_TRUNCATION est défini dans dwFlags, la mémoire tampon de destination n’est pas modifiée. Si l’indicateur n’est pas défini, 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
RtlStringCbVPrintfExW et RtlStringCbVPrintfExA doivent être utilisés à la place des fonctions suivantes :
- vsprintf
- vswprintf
- _vsnprintf
- _vsnwprintf
RtlStringCbVPrintfExW et RtlStringCbVPrintfExA ajoutent à la fonctionnalité de RtlStringCbVPrintf 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. Les indicateurs peuvent être passés à la fonction pour un contrôle supplémentaire.
Pour plus d’informations sur les listes d’arguments typées va_list, consultez la documentation Microsoft Windows SDK.
Utilisez RtlStringCbVPrintfExW pour gérer les chaînes Unicode et RtlStringCbVPrintfExA 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 » | RtlStringCbVPrintfExW |
char | "chaîne" | RtlStringCbVPrintfExA |
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 avoir la valeur NULL , sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini, auquel cas l’un ou l’autre peut avoir la valeur NULL. Si pszDest a la valeur NULL, pszFormat doit être NULL ou pointer vers une chaîne vide.
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 dans Windows XP avec Service Pack 1 (SP1) et versions ultérieures de Windows. |
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 |