Fonction RtlUnicodeStringPrintf (ntstrsafe.h)

  • Article

La fonction RtlUnicodeStringPrintf 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 RtlUnicodeStringPrintf(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
        ...              
);

Paramètres

[out] DestinationString

Pointeur vers une structure UNICODE_STRING qui reçoit une chaîne mise en forme. RtlUnicodeStringPrintf 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.

[in] pszFormat

Pointeur vers une chaîne de texte terminée par null qui contient des directives de mise en forme de style printf.

...

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

Valeur retournée

RtlUnicodeStringPrintf 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, que la chaîne a été copié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 tampon insuffisant. La mémoire tampon de destination contient une version tronquée et terminée par null du résultat prévu.
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.
 

RtlUnicodeStringPrintf retourne la valeur STATUS_INVALID_PARAMETER lorsque l’un des éléments suivants se produit :

  • Le contenu de la structure UNICODE_STRING vers laquelle pointe le paramètre DestinationString n’est pas valide.
  • La mémoire tampon de destination est déjà pleine.
  • Un pointeur NULL est présent.
  • La longueur de la mémoire tampon de destination est égale à zéro, mais une chaîne source de longueur différente de zéro est présente.
Pour plus d’informations sur le test des valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

Remarques

La fonction RtlUnicodeStringPrintf 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. La fonction n’arrête pas la chaîne résultante avec un caractère null.

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. Si vous devez gérer les valeurs de pointeur NULL , utilisez la fonction RtlUnicodeStringPrintfEx .

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

RtlUnicodeStringPrintfEx

RtlUnicodeStringVPrintf

RtlUnicodeStringVPrintfEx

UNICODE_STRING