Fonction RtlStringCchCopyNW (ntstrsafe.h)

Les fonctions RtlStringCchCopyNW et RtlStringCchCopyNA copient une chaîne comptée de caractères dans une mémoire tampon tout en limitant la taille de la chaîne copiée.

Syntaxe

NTSTRSAFEDDI RtlStringCchCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cchToCopy
);

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, jusqu’aux caractères cchSrc , est copiée dans la mémoire tampon au niveau pszDest et terminée par un caractère null.

[in] cchDest

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

[in] pszSrc

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

cchToCopy

Nombre maximal de caractères à copier de pszSrc vers la mémoire tampon fournie par pszDest.

Valeur retournée

La fonction retourne l’une des valeurs NTSTATUS répertoriées dans le tableau suivant. Pour plus d’informations sur le test des valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

Code de retour	Description
STATUS_SUCCESS	Cette status de réussite 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 n’a pas été effectuée en raison d’un espace insuffisant dans la mémoire tampon de destination. La mémoire tampon de destination contient une version tronquée de la chaîne copiée.
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. La mémoire tampon de destination était déjà pleine. Un pointeur NULL était présent. La longueur de la mémoire tampon de destination était égale à zéro, mais une chaîne source de longueur différente de zéro était présente.

Remarques

RtlStringCchCopyNW et RtlStringCchCopyNA doivent être utilisés au lieu de strncpy.

Les fonctions copient un nombre donné de caractères à partir d’une chaîne source. RtlStringCchCopyNW et RtlStringCchCopyNA reçoivent la taille, en caractères, de la mémoire tampon de destination pour s’assurer que les fonctions n’écrivent pas au-delà de la fin de la mémoire tampon.

Notez que ces fonctions se comportent différemment de strncpy à un point de vue. Si cchSrc est supérieur au nombre de caractères dans pszSrc, RtlStringCchCopyNW et RtlStringCchCopyNA, contrairement à strncpy, ne continuent pas à padper pszDest avec des caractères null tant que les caractères cchSrc n’ont pas été copiés.

Utilisez RtlStringCchCopyNW pour gérer les chaînes Unicode et RtlStringCchCopyNA 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 »	RtlStringCchCopyNW
char	"chaîne"	RtlStringCchCopyNA

 

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 les valeurs de pointeur de chaîne NULL , utilisez RtlStringCchCopyNEx.

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

RtlStringCbCopyN

RtlStringCchCopy

RtlStringCchCopyNEx