Fonction RtlStringCchCopyW (ntstrsafe.h)

Article
05/03/2024

Les fonctions RtlStringCchCopyW et RtlStringCchCopyA copient une chaîne source terminée par null dans une mémoire tampon de destination de longueur spécifiée.

Syntaxe

NTSTRSAFEDDI RtlStringCchCopyW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  NTSTRSAFE_PCWSTR pszSrc
);

Paramètres

[out] pszDest

Pointeur vers une mémoire tampon fournie par l’appelant qui reçoit la chaîne copiée. La chaîne au niveau pszSrc est copiée dans la mémoire tampon à l’emplacement pszDest et se termine par un caractère null.

[in] cchDest

Taille, en caractères, de la mémoire tampon de destination. Le nombre maximal de caractères autorisé est NTSTRSAFE_MAX_CCH.

[in] pszSrc

Pointeur vers une chaîne terminée par null fournie par l’appelant.

Valeur retournée

La fonction retourne l’une des valeurs NTSTATUS répertoriées dans le tableau suivant. Pour plus d’informations sur la façon de tester les valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

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 le paragraphe suivant. La fonction retourne la valeur STATUS_INVALID_PARAMETER lorsque : La valeur dans cchDest est supérieure à la taille maximale de la mémoire tampon. Un pointeur NULL était présent. La longueur de la mémoire tampon de destination était égale à zéro à l’entrée.

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 le paragraphe suivant.

La fonction retourne la valeur STATUS_INVALID_PARAMETER lorsque :

La valeur dans cchDest est supérieure à la taille maximale de la mémoire tampon.
Un pointeur NULL était présent.
La longueur de la mémoire tampon de destination était égale à zéro à l’entrée.

Remarques

RtlStringCchCopyW et RtlStringCchCopyA doivent être utilisés à la place des fonctions suivantes :

strcpy
wcscpy

Ces fonctions ne remplacent pas strncpy. Utilisez RtlStringCchCopyN ou RtlStringCchCopyNEx pour remplacer strncpy.

La taille, en caractères, de la mémoire tampon de destination est fournie à RtlStringCchCopyW et RtlStringCchCopyA pour s’assurer qu’ils n’écrivent pas au-delà de la fin de la mémoire tampon.

Utilisez RtlStringCchCopyW pour gérer les chaînes Unicode et RtlStringCchCopyA pour gérer les chaînes ANSI. Le formulaire que vous utilisez dépend de vos données, comme indiqué dans le tableau suivant.

Type de données String	Littéral de chaîne	Fonction
WCHAR	L"string »	RtlStringCchCopyW
char	"chaîne"	RtlStringCchCopyA

Si pszSrc et pszDest pointent vers des chaînes qui se chevauchent, le comportement de la fonction n’est pas défini.

Ni pszSrc ni pszDest ne peuvent être NULL. Si vous devez gérer des valeurs de pointeur de chaîne NULL , utilisez RtlStringCchCopyEx.

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

RtlStringCbCopy

RtlStringCchCopyEx

Partager via