Fonction RtlStringCbPrintfExA (ntstrsafe.h)

  • Article

Les fonctions RtlStringCbPrintfExW et RtlStringCbPrintfExA 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 RtlStringCbPrintfExA(
  [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,
                  ...             
);

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 de 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] 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 lavaleur 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 pointeur de fin 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 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
Si la valeur est définie, pszDest ou pszSrc, ou les deux, peut avoir la valeur NULL. Les pointeurs pszSrcNULL sont traités comme des chaînes vides (TEXT(«  »)), qui peuvent être copiées. 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.

...

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

RtlStringCbPrintfExW et RtlStringCbPrintfExA doivent être utilisés à la place des fonctions suivantes :

  • sprintf
  • swprintf
  • _snprintf
  • _snwprintf
Toutes ces fonctions acceptent une chaîne de format et une liste d’arguments, les interprètent et créent une chaîne mise en forme. La taille, en octets, de la mémoire tampon de destination est fournie à RtlStringCbPrintfExW et RtlStringCbPrintfExA pour s’assurer qu’ils n’écrivent pas au-delà de la fin de la mémoire tampon.

RtlStringCbPrintfExW et RtlStringCbPrintfExA ajoutent aux fonctionnalités de RtlStringCbPrintf 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.

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

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 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 avoir la valeur NULL ou pointer vers une chaîne vide.

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 à partir de Windows XP avec Service Pack 1 (SP1).
Plateforme cible Desktop (Expérience utilisateur)
En-tête ntstrsafe.h (inclure Ntstrsafe.h)
Bibliothèque Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Voir aussi

RtlStringCbVPrintfEx

RtlStringCchPrintf

RtlStringCchPrintfEx