Fonction RtlStringCchCopyUnicodeString (ntstrsafe.h)

  • Article

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

Syntaxe

NTSTRSAFEDDI RtlStringCchCopyUnicodeString(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  PCUNICODE_STRING SourceString
);

Paramètres

[out] pszDest

Pointeur vers une mémoire tampon 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 au niveau pszDest et terminée par un caractère Null.

[in] cchDest

Taille, en caractères, de la mémoire tampon de destination. La mémoire tampon doit être suffisamment grande pour la chaîne et le caractère null de fin. Le nombre maximal de caractères est NTSTRSAFE_UNICODE_STRING_MAX_CCH.

[in] SourceString

Pointeur vers une structure UNICODE_STRING qui contient la chaîne à copier. Le nombre maximal de caractères dans la chaîne est NTSTRSAFE_UNICODE_STRING_MAX_CCH.

Valeur retournée

RtlStringCchCopyUnicodeString 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 un caractère 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 et terminée par un caractère 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.
 

RtlStringCchCopyUnicodeString 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 valeur dans cbDest est supérieure à la taille maximale de la mémoire tampon.
  • La mémoire tampon de destination (vers laquelle pointe pszDest ) 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 les valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

Remarques

La fonction RtlStringCchCopyUnicodeString utilise la taille de la mémoire tampon de destination (spécifiée par cchDest ) 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 des valeurs de pointeur NULL , utilisez la fonction RtlStringCchCopyUnicodeStringEx .

Pour plus d’informations sur les fonctions de chaîne sécurisée, consultez Utilisation de 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 (include Ntstrsafe.h)
Bibliothèque Ntstrsafe.lib
IRQL Toutes les chaînes si manipulées résident toujours en mémoire, sinon PASSIVE_LEVEL

Voir aussi

RtlStringCbCopyUnicodeString

RtlStringCchCopyUnicodeStringEx

UNICODE_STRING