Fonction RtlStringCchVPrintfExA (ntstrsafe.h)

Les fonctions RtlStringCchVPrintfExW et RtlStringCchVPrintfExA 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 RtlStringCchVPrintfExA(
  [out]           NTSTRSAFE_PSTR  pszDest,
  [in]            size_t          cchDest,
  [out, optional] NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags,
  [in, optional]  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 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 des arguments fournis par argList. Le pointeur pszDest peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

[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. Si pszDest a la valeur NULL, cchDest 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 pointeur de fin de chaîne null résultant de la mémoire tampon de destination.

[out, optional] pcchRemaining

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 vers 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.

Valeur	Signification
STRSAFE_FILL_BEHIND_NULL	Si la fonction est définie et réussit, l’octet faible de dwFlags est utilisé pour remplir la partie de la mémoire tampon de destination qui suit le caractère null de fin.
STRSAFE_IGNORE_NULLS	S’il est défini, pszDest peut avoir la valeur NULL. Les pointeurs pszDest NULL ne peuvent pas recevoir de chaînes vides.
STRSAFE_FILL_ON_FAILURE	Si la fonction est définie et échoue, l’octet faible de dwFlags est utilisé pour remplir l’intégralité de la mémoire tampon de destination, et la mémoire tampon est terminée par null. Cette opération remplace tout contenu de mémoire tampon préexistant.
STRSAFE_NULL_ON_FAILURE	Si la fonction est définie et échoue, la mémoire tampon de destination est définie sur une chaîne vide (TEXT(«  »)). Cette opération remplace tout contenu de mémoire tampon préexistant.
STRSAFE_NO_TRUNCATION	Si la fonction est définie et retourne STATUS_BUFFER_OVERFLOW, le contenu de la mémoire tampon de destination n’est pas modifié.

[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 le test des 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 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. 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.
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 : Un indicateur non valide a été spécifié. 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 sans l’indicateur STRSAFE_IGNORE_NULLS. Le pointeur de la mémoire tampon de destination était NULL, mais la taille de la mémoire tampon n’était pas égale à zéro. Le pointeur de la mémoire tampon de destination était NULL ou sa longueur était égale à zéro, mais une chaîne source de longueur différente de zéro était présente.

Remarques

RtlStringCchVPrintfExW et RtlStringCchVPrintfExA doivent être utilisés au lieu des fonctions suivantes :

• vsprintf
• vswprintf
• _vsnprintf
• _vsnwprintf

Toutes ces fonctions acceptent une chaîne de format et ses arguments, fournis sous forme de liste d’arguments de type va_list, et retournent une chaîne mise en forme. RtlStringCchVPrintfExW et RtlStringCchVPrintfExA reçoivent la taille, en caractères, de la mémoire tampon de destination pour s’assurer qu’ils n’écrivent pas au-delà de la fin de la mémoire tampon.

RtlStringCchVPrintfExW et RtlStringCchVPrintfExA ajoutent aux fonctionnalités de RtlStringCchVPrintf en retournant un pointeur vers la fin de la chaîne de destination, ainsi que le nombre de caractères 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 de type va_list, consultez la documentation Microsoft Windows SDK.

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

 

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.

pszDest ne peut pas avoir la valeur NULL , sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini.

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 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 (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

RtlStringCbVPrintfEx

RtlStringCchPrintfEx

RtlStringCchVPrintf