Fonction RtlStringCchVPrintfW (ntstrsafe.h)

Article
05/03/2024

Les fonctions RtlStringCchVPrintfW et RtlStringCchVPrintfA 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 RtlStringCchVPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  NTSTRSAFE_PCWSTR 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] 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.

[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
STATUS_SUCCESS	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.
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 créée.
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

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.

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 créée.

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

RtlStringCchVPrintfW et RtlStringCchVPrintfA doivent être utilisés à la place des fonctions suivantes :

vsprintf
vswprintf
_vsnprintf
_vsnwprintf

Toutes ces fonctions acceptent une chaîne de format et ses arguments, qui sont fournis sous forme de liste d’arguments de type va_list, et retournent une chaîne mise en forme. RtlStringCchVPrintfW et RtlStringCchVPrintfA reçoivent la taille, en caractères, de la mémoire tampon de destination pour garantir que les fonctions n’écrivent pas au-delà de la fin de la mémoire tampon.

Pour plus d’informations sur les listes d’arguments typées va_list, consultez la documentation Microsoft Windows SDK.

Utilisez RtlStringCchVPrintfW pour gérer les chaînes Unicode et RtlStringCchVPrintfA 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 »	RtlStringCchVPrintfW
char	"chaîne"	RtlStringCchVPrintfA

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 des valeurs de pointeur de chaîne NULL , utilisez RtlStringCchVPrintfEx.

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

Voir aussi

RtlStringCbVPrintf

RtlStringCchPrintf

RtlStringCchVPrintfEx

Partager via