Fonction RtlUnicodeStringCbCopyN (ntstrsafe.h)

Article
05/03/2024

La fonction RtlUnicodeStringCbCopyN copie une chaîne d’une structure UNICODE_STRING à une autre tout en limitant la taille de la chaîne copiée.

Syntaxe

NTSTRSAFEDDI RtlUnicodeStringCbCopyN(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString,
  [in]  size_t           cbToCopy
);

Paramètres

[out] DestinationString

Pointeur vers une structure UNICODE_STRING qui reçoit la chaîne copiée. La chaîne vers laquelle pointe la structure UNICODE_STRING du paramètre SourceString est copiée dans la mémoire tampon vers laquelle pointe la structure UNICODE_STRING du paramètre DestinationString. Le nombre maximal d’octets dans la mémoire tampon de chaîne de la structure DestinationString est NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

Pointeur vers une structure de UNICODE_STRING qui contient la chaîne à copier. 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] cbToCopy

Nombre d’octets à copier de la source vers la destination.

Valeur retournée

RtlUnicodeStringCbCopyN retourne l’une des valeurs NTSTATUS suivantes.

Code de retour	Description
STATUS_SUCCESS	Ce succès status signifie que les données sources étaient présentes, que la chaîne a été copiée sans troncation.
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 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 le paragraphe suivant.

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

Le contenu de la structure 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.
La valeur du paramètre cbToCopy est supérieure à NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Pour plus d’informations sur le test des valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

Remarques

La fonction RtlUnicodeStringCbCopyN 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. La fonction n’arrête pas la chaîne résultante avec une valeur de caractère null (c’est-à-dire avec zéro).

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 RtlUnicodeStringCbCopyNEx .

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

RtlUnicodeStringCbCopyNEx

RtlUnicodeStringCchCopyN

UNICODE_STRING