Partager via


Fonction RtlUnicodeStringPrintf (ntstrsafe.h)

La fonction RtlUnicodeStringPrintf crée une chaîne de texte, avec une mise en forme basée sur des 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 qui pszFormat spécifie et 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 directives de mise en forme-style.

...

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

Valeur de retour

RtlUnicodeStringPrintf retourne l’une des valeurs NTSTATUS suivantes.

Retourner le code Description
STATUS_SUCCESS
Cette réussite état 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 état signifie que l’opération n’a pas été 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 état 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’une des opérations suivantes se produit :

  • Contenu de la structure UNICODE_STRING à laquelle 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 la façon de tester des valeurs NTSTATUS, consultez Using NTSTATUS Values.

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 valeurs de pointeur null, utilisez la fonction RtlUnicodeStringPrintfEx.

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

RtlUnicodeStringPrintfEx

RtlUnicodeStringVPrintf

RtlUnicodeStringVPrintfEx

UNICODE_STRING