Fonction RtlStringCbCopyUnicodeString (ntstrsafe.h)

Article
02/07/2025

La fonction RtlStringCbCopyUnicodeString copie le contenu d’une structure UNICODE_STRING vers une destination spécifiée.

Syntaxe

NTSTRSAFEDDI RtlStringCbCopyUnicodeString(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  PCUNICODE_STRING SourceString
);

Paramètres

[out] pszDest

Pointeur vers une mémoire tampon qui reçoit la chaîne copiée. Chaîne vers laquelle la structure UNICODE_STRING du paramètre SourceString est copiée dans la mémoire tampon à pszDest et se termine par un caractère Null.

[in] cbDest

Taille, en octets, de la mémoire tampon de destination vers laquelle pszDest pointe. La mémoire tampon doit être suffisamment grande pour contenir la chaîne et le caractère null de fin. Le nombre maximal d’octets dans la mémoire tampon est NTSTRSAFE_UNICODE_STRING_MAX_CCH * taille de(WCHAR).

[in] SourceString

Pointeur vers une structure UNICODE_STRING qui contient la chaîne à copier. Le nombre maximal d’octets dans la chaîne est NTSTRSAFE_UNICODE_STRING_MAX_CCH * taille de(WCHAR).

Valeur de retour

RtlStringCbCopyUnicodeString 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 l’état signifie que l’opération de copie 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.

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

Le contenu de la structure UNICODE_STRING n’est pas valide.
La valeur de cbDest est supérieure à la taille maximale de la mémoire tampon.
La mémoire tampon de destination (qui pszDest pointe vers) est déjà pleine.
Un pointeur de mémoire tampon est 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 la façon de tester des valeurs NTSTATUS, consultez Using NTSTATUS Values.

Remarques

La fonction RtlStringCbCopyUnicodeString utilise la taille de la mémoire tampon de destination (que le paramètre cbDest spécifie) pour s’assurer que l’opération de copie n’écrit pas au-delà de la fin de la mémoire tampon.

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

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

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 à partir de Windows XP avec Service Pack 1 (SP1).
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

RtlStringCbCopyUnicodeStringEx

RtlStringCchCopyUnicodeString

UNICODE_STRING

Partager via