Fonction RtlStringCbVPrintfExA (ntstrsafe.h)

Article
07/16/2024

Les fonctions RtlStringCbVPrintfExW et RtlStringCbVPrintfExA créent une chaîne de texte comptée en octets, avec une mise en forme basée sur des informations de mise en forme fournies.

Syntaxe

NTSTRSAFEDDI RtlStringCbVPrintfExA(
  [out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]            size_t          cbDest,
  [out, optional] NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional] size_t          *pcbRemaining,
  [in]            DWORD           dwFlags,
  [in, optional]  NTSTRSAFE_PCSTR 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 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 les 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 et 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 est NULL, cbDest doit être égal à zéro.

[out, optional] ppszDestEnd

Si l’appelant fournit un pointeur d’adresse NULL nonNULL, une fois l’opération terminée, la fonction charge cette adresse avec un pointeur vers la marque de fin de chaîne null résultante de la mémoire tampon de destination.

[out, optional] pcbRemaining

Si l’appelant fournit un pointeur d’adresse null non, 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 la fin du caractère null.

[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	Si la valeur est définie, pszDest ou pszSrc, ou les deux, peut être NULL. NULLpszSrc pointeurs sont traités comme des chaînes vides (TEXT(« »)), qui peuvent être copiées. NULLpszDest pointeurs ne peuvent pas recevoir de chaînes vides.
STRSAFE_FILL_ON_FAILURE	Si la fonction échoue et que la fonction échoue, l’octet faible de dwFlags est utilisé pour remplir la mémoire tampon de destination entière 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 échoue et que la fonction é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 directives de mise en forme-style. Le pointeur pszFormat peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags .

[in] argList

Une liste d’arguments va_list-typé. 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 de retour

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 des valeurs NTSTATUS, consultez Using NTSTATUS Values.

Retourner le code	Description
STATUS_SUCCESS	Cette réussite état 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 état signifie que l’opération n’a pas été 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 état 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 de cbDest 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 de 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.

Retourner le code

Description

STATUS_SUCCESS

Cette réussite état 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 état signifie que l’opération n’a pas été 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 état 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 de cbDest 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 de 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

RtlStringCbVPrintfExW et RtlStringCbVPrintfExA doivent être utilisés au lieu des fonctions suivantes :

vsprintf
vswprintf
_vsnprintf
_vsnwprintf

Toutes ces fonctions acceptent une chaîne de format, ainsi qu’un ensemble d’arguments dans une liste d’arguments va_list-typé et retournent une chaîne mise en forme. La taille, en octets, de la mémoire tampon de destination est fournie à RtlStringCbVPrintfExW et RtlStringCbVPrintfExA pour s’assurer qu’ils n’écrivent pas au-delà de la fin de la mémoire tampon.

RtlStringCbVPrintfExW et RtlStringCbVPrintfExA ajouter aux fonctionnalités de RtlStringCbVPrintf en retournant un pointeur à la fin de la chaîne de destination, ainsi que le nombre d’octets laissés 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és va_list, consultez la documentation du Kit de développement logiciel (SDK) Microsoft Windows.

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 de chaîne	Littéral de chaîne	Fonction
WCHAR	L"string »	RtlStringCbVPrintfExW
char	« string »	RtlStringCbVPrintfExA

Si pszDest et pszFormat pointer 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.

Ni pszFormat ni pszDest ne peut être NULL, sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini, auquel cas l’une ou l’autre peut être NULL. Si pszDest est 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 Using Safe String Functions.

Exigences

Exigence	Valeur
client minimum pris en charge	Disponible dans Windows XP avec Service Pack 1 (SP1) et versions ultérieures de Windows.
plateforme cible	Bureau
d’en-tête	ntstrsafe.h (include Ntstrsafe.h)
bibliothèque	Ntstrsafe.lib
IRQL	Si les chaînes manipulées résident toujours en mémoire, sinon PASSIVE_LEVEL

Voir aussi

RtlStringCbPrintfEx

RtlStringCbVPrintf

RtlStringCchVPrintfEx

Partager via