Fonction RtlStringCbCopyNW (ntstrsafe.h)

Article
02/29/2024

Les fonctions RtlStringCbCopyNW et RtlStringCbCopyNA copient une chaîne d’octets dans une mémoire tampon tout en limitant la taille de la chaîne copiée.

Syntaxe

NTSTRSAFEDDI RtlStringCbCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cbToCopy
);

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’à des octets cbSrc , est copiée dans la mémoire tampon au niveau pszDest et terminée par un caractère null.

[in] cbDest

Taille, en octets, 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.

Pour les chaînes Unicode, le nombre maximal d’octets est NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Pour les chaînes ANSI, le nombre maximal d’octets est NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

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

cbToCopy

Nombre maximal d’octets à copier de pszSrc vers 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 cbDest 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.

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 cbDest 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

RtlStringCbCopyNW et RtlStringCbCopyNA doivent être utilisés au lieu de strncpy. Toutefois, ces fonctions diffèrent par leur comportement. Si cbSrc est supérieur au nombre d’octets dans pszSrc, les fonctions RtlStringCbCopyN (contrairement à strncpy) ne remplissent pas pszDest avec des caractères null tant que les octets cbSrc n’ont pas été copiés.

RtlStringCbCopyN copie un nombre donné d’octets d’une chaîne source. La taille, en octets, de la mémoire tampon de destination est fournie à la fonction pour garantir que RtlStringCbCopyN n’écrit pas au-delà de la fin de cette mémoire tampon.

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

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 , consultez RtlStringCbCopyNEx.

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

RtlStringCbCopy

RtlStringCbCopyNEx

RtlStringCchCopyN

Partager via