Fonction RtlUnicodeStringPrintfEx (ntstrsafe.h)

Article
08/07/2023

La fonction RtlUnicodeStringPrintfEx crée une chaîne de texte, avec une mise en forme basée sur les informations de mise en forme fournies, et stocke la chaîne dans une structure UNICODE_STRING .

Syntaxe

NTSTRSAFEDDI RtlUnicodeStringPrintfEx(
  [out]           PUNICODE_STRING  DestinationString,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags,
  [in]            NTSTRSAFE_PCWSTR pszFormat,
                  ...              
);

Paramètres

[out] DestinationString

Facultatif. Pointeur vers une structure UNICODE_STRING qui reçoit une chaîne mise en forme. RtlUnicodeStringPrintfEx crée cette chaîne à partir de la chaîne de mise en forme spécifiée par pszFormat et de la liste d’arguments de la fonction. Le nombre maximal de caractères dans la chaîne est NTSTRSAFE_UNICODE_STRING_MAX_CCH. DestinationString peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

[out, optional] RemainingString

facultatif. Si l’appelant fournit un pointeur non NULL vers une structure UNICODE_STRING , RtlUnicodeStringPrintfEx définit le membre Buffer de cette structure à la fin de la chaîne mise en forme, définit le membre Length de la structure sur zéro et définit le membre MaximumLength de la structure sur le nombre d’octets restants dans la mémoire tampon de destination. RemainingString peut avoir la valeur NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

[in] dwFlags

Un ou plusieurs indicateurs et, éventuellement, un octet de remplissage. Les indicateurs sont définis comme suit :

STRSAFE_FILL_BEHIND

Si cet indicateur est défini et que la fonction réussit, l’octet faible de dwFlags est utilisé pour remplir la partie de la mémoire tampon de destination qui suit le dernier caractère de la chaîne.

STRSAFE_IGNORE_NULLS

Si cet indicateur est défini, le pointeur source ou de destination, ou les deux, peuvent être NULL. RtlUnicodeStringPrintfEx traite les pointeurs de mémoire tampon source NULL comme des chaînes vides (TEXT(« »)), qui peuvent être copiées. Les pointeurs de mémoire tampon de destination NULL ne peuvent pas recevoir de chaînes vides.

STRSAFE_FILL_ON_FAILURE

Si cet indicateur est défini et que la fonction échoue, l’octet faible de dwFlags est utilisé pour remplir la mémoire tampon de destination entière. Cette opération remplace tout contenu de mémoire tampon préexistant.

STRSAFE_NULL_ON_FAILURE

Si cet indicateur est défini 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 cet indicateur est défini et que la fonction retourne STATUS_BUFFER_OVERFLOW, le contenu de la mémoire tampon de destination n’est pas modifié.

STRSAFE_ZERO_LENGTH_ON_FAILURE

Si cet indicateur est défini et que la fonction retourne STATUS_BUFFER_OVERFLOW, la longueur de chaîne de destination est définie sur zéro octets.

[in] pszFormat

Pointeur vers une chaîne de texte terminée par null qui contient des directives de mise en forme de style printf. Ce pointeur peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

...

facultatif. Liste d’arguments interprétés par RtlUnicodeStringPrintfEx , en fonction des directives de mise en forme spécifiées par la chaîne pszFormat .

Valeur retournée

RtlUnicodeStringPrintfEx retourne l’une des valeurs NTSTATUS suivantes.

Code de retour	Description
STATUS_SUCCESS	Cette réussite status signifie que les données sources étaient présentes et que les chaînes ont été concaténées sans troncation.
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 copié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 la liste suivante.

RtlUnicodeStringPrintfEx retourne la valeur STATUS_INVALID_PARAMETER lorsque l’une des opérations suivantes se produit :

Le contenu d’une structure UNICODE_STRING n’est pas valide.
Un indicateur non valide est spécifié dans dwFlags.
La mémoire tampon de destination est déjà pleine.
Un pointeur de mémoire tampon est NULL et l’indicateur STRSAFE_IGNORE_NULLS n’est pas spécifié dans dwFlags.
Le pointeur de la mémoire tampon de destination est NULL, mais la taille de la mémoire tampon n’est pas égale à zéro.
Le pointeur de la mémoire tampon de destination est NULL, ou sa longueur est égale à zéro, mais une chaîne source de longueur différente de zéro est présente.

Pour plus d’informations sur la façon de tester les valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

Remarques

La fonction RtlUnicodeStringPrintfEx utilise la taille de la mémoire tampon de destination pour s’assurer que l’opération de mise en forme de chaîne n’écrit pas au-delà de la fin de la mémoire tampon. Par défaut, la fonction ne termine pas la chaîne résultante avec une valeur de caractère null (c’est-à-dire avec zéro). En option, l’appelant peut utiliser l’indicateur STRSAFE_FILL_BEHIND et une valeur d’octet de remplissage égale à zéro pour terminer null une chaîne résultante qui n’occupe pas l’intégralité de la mémoire tampon de destination.

RtlUnicodeStringPrintfEx ajoute aux fonctionnalités de la fonction RtlUnicodeStringPrintf en retournant une structure UNICODE_STRING qui identifie la fin de la chaîne de destination et le nombre d’octets inutilisés dans cette chaîne. Vous pouvez passer des indicateurs à RtlUnicodeStringPrintfEx pour un contrôle supplémentaire.

Si la chaîne de format et la chaîne de destination se chevauchent, le comportement de la fonction n’est pas défini.

Les pointeurs pszFormat et DestinationString ne peuvent pas être NULL , sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini dans dwFlags. Si STRSAFE_IGNORE_NULLS est défini, l’un de ces pointeurs ou les deux peuvent avoir la valeur NULL. Si le pointeur DestinationString a la valeur NULL, le pointeur 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 Utilisation de 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 (include Ntstrsafe.h)
Bibliothèque	Ntstrsafe.lib
IRQL	PASSIVE_LEVEL