Fonction RtlStringCbCopyW (ntstrsafe.h)
Les fonctions RtlStringCbCopyW et RtlStringCbCopyA copient une chaîne comptée en octets dans une mémoire tampon.
Syntaxe
NTSTRSAFEDDI RtlStringCbCopyW(
[out] NTSTRSAFE_PWSTR pszDest,
[in] size_t cbDest,
[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 à pszSrc est copiée dans la mémoire tampon à l’emplacement 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.
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 |
---|---|
|
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. |
|
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 null du résultat prévu. |
|
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 :
|
Remarques
RtlStringCbCopyA et RtlStringCbCopyW doivent être utilisés au lieu des fonctions suivantes :
- strcpy
- wcscpy
La taille de la mémoire tampon de destination est fournie à la fonction pour garantir que RtlStringCbCopy n’écrit pas au-delà de la fin de la mémoire tampon.
Utilisez RtlStringCbCopyW pour gérer les chaînes Unicode et RtlStringCbCopyA 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 » | RtlStringCbCopyW |
char | "chaîne" | RtlStringCbCopyA |
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 RtlStringCbCopyEx.
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 |