Fonction RtlStringCchPrintfExA (ntstrsafe.h)

Article
07/16/2024

Les fonctions RtlStringCchPrintfExW et RtlStringCchPrintfExA créent une chaîne de texte comptée en caractères, avec une mise en forme basée sur des informations de mise en forme fournies.

Syntaxe

NTSTRSAFEDDI RtlStringCchPrintfExA(
  [out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]            size_t          cchDest,
  [out, optional] NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags,
  [in]            NTSTRSAFE_PCSTR pszFormat,
                  ...             
);

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 la liste d’arguments de la fonction. 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 et le caractère null de fin. Le nombre maximal de caractères autorisés est NTSTRSAFE_MAX_CCH. Si pszDest est NULL, cchDest 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 mémoire tampon de destination résultante null fin de chaîne.

[out, optional] pcchRemaining

Si l’appelant fournit un pointeur d’adresse null nonNULL, la fonction charge l’adresse avec le nombre de caractères inutilisés dans la mémoire tampon vers laquelle pointe pszDest, y compris 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	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] 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 .

...

Liste facultative d’arguments interprétés par la fonction, en fonction des directives de mise en forme contenues dans la chaîne 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 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 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 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 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 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

RtlStringCchPrintfExW et RtlStringCchPrintfExA doivent être utilisés au lieu des fonctions suivantes :

sprintf
swprintf
_ snprintf
_ snwprintf

Toutes ces fonctions acceptent une chaîne de format et une liste d’arguments et retournent une chaîne mise en forme. RtlStringCchPrintfExW et RtlStringCchPrintfExA accepter la taille, en caractères, de la mémoire tampon de destination pour s’assurer qu’elles n’écrivent pas au-delà de la fin de cette mémoire tampon.

RtlStringCchPrintfExW et RtlStringCchPrintfExA ajouter aux fonctionnalités de RtlStringCchPrintf en retournant un pointeur à la fin de la chaîne de destination, ainsi que le nombre de caractères laissés inutilisés dans cette chaîne. Les indicateurs peuvent être passés à la fonction pour un contrôle supplémentaire.

Utilisez RtlStringCchPrintfExW pour gérer les chaînes Unicode et RtlStringCchPrintfExA 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 »	RtlStringCchPrintfExW
char	« string »	RtlStringCchPrintfExA

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.

Ni pszSrc ni pszDest ne peut être NULL, sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini, auquel cas ou les deux peuvent être NULL. Si pszDest est NULL, pszSrc 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

RtlStringCchPrintf

RtlStringCchVPrintfEx

Partager via