Fonction RtlUnicodeStringCopy (ntstrsafe.h)

La fonction RtlUnicodeStringCopy copie une chaîne d’une structure UNICODE_STRING à une autre.

Syntaxe

NTSTRSAFEDDI RtlUnicodeStringCopy(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString
);

Paramètres

[out] DestinationString

Pointeur vers une structure UNICODE_STRING . La chaîne source est copiée dans la chaîne de destination. Le nombre maximal d’octets dans la mémoire tampon de chaîne de la structure est NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

Pointeur vers une structure UNICODE_STRING . Cette structure inclut une mémoire tampon qui contient la chaîne source. Cette chaîne sera copiée dans la chaîne de destination. Le nombre maximal d’octets dans la mémoire tampon de chaîne de la structure est NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Valeur retournée

RtlUnicodeStringCopy 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 de copie ne s’est pas terminée en raison d’un espace tampon insuffisant. La mémoire tampon de destination contient une version tronquée de la chaîne source.
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.
 

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

  • Le contenu d’une structure de UNICODE_STRING n’est pas valide.
  • La mémoire tampon de destination est déjà pleine.
  • Un pointeur de mémoire tampon a la valeur NULL.
  • 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 RtlUnicodeStringCopy utilise la taille de la mémoire tampon de destination pour s’assurer que l’opération de copie n’écrit pas au-delà de la fin de la mémoire tampon. Si la chaîne doit être tronquée à la fin de la mémoire tampon de destination, la fonction ne termine pas la chaîne résultante avec un caractère null.

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

Les pointeurs SourceString et DestinationString ne peuvent pas être NULL. Si vous devez gérer les valeurs de pointeur NULL , utilisez la fonction RtlUnicodeStringCopyEx .

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 PASSIVE_LEVEL

Voir aussi

RtlUnicodeStringCopyEx

UNICODE_STRING