Fonction RtlStringCbCopyExW (ntstrsafe.h)
Les fonctions RtlStringCbCopyExW et RtlStringCbCopyExA copient une chaîne comptée en octets dans une mémoire tampon.
Syntaxe
NTSTRSAFEDDI RtlStringCbCopyExW(
[out, optional] NTSTRSAFE_PWSTR pszDest,
[in] size_t cbDest,
[in, optional] NTSTRSAFE_PCWSTR pszSrc,
[out, optional] NTSTRSAFE_PWSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
Paramètres
[out, optional] 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. Le pointeur pszDest peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.
[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)
Si pszDest a lavaleur NULL, cbDest doit être égal à zéro.
[in, optional] pszSrc
Pointeur vers une chaîne null fournie par l’appelant. Le pointeur pszSrc peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.
[out, optional] ppszDestEnd
Si l’appelant fournit un pointeur d’adresse non NULL , une fois l’opération de copie terminée, la fonction charge cette adresse avec un pointeur vers la terminaison de chaîne NULL résultante de la mémoire tampon de destination.
[out, optional] pcbRemaining
Si l’appelant fournit un pointeur d’adresse non NULL , la fonction charge l’adresse avec le nombre d’octets inutilisés qui se trouvent dans la mémoire tampon pointée vers pszDest, y compris les octets utilisés pour le caractère null de fin.
[in] dwFlags
Un ou plusieurs indicateurs et, éventuellement, un octet de remplissage. Les indicateurs sont définis comme suit :
Valeur | Signification |
---|---|
STRSAFE_FILL_BEHIND_NULL | Si cet indicateur est défini et que la fonction réussit, l’octet faible de dwFlags est utilisé pour remplir la partie de la mémoire tampon de destination qui suit le caractère null de fin. |
STRSAFE_IGNORE_NULLS | Si cet indicateur est défini, pszDest ou pszSrc, ou les deux, peut être NULL. Les pointeurs pszSrcNULL sont traités comme des chaînes vides (TEXT(« »)), qui peuvent être copiées. Les pointeurs pszDest NULL ne peuvent pas recevoir de chaînes vides. |
STRSAFE_FILL_ON_FAILURE | Si cet indicateur est défini et que la fonction échoue, l’octet faible de dwFlags est utilisé pour remplir l’intégralité de la mémoire tampon de destination et la mémoire tampon est terminée par null. Cette opération remplace tout contenu de mémoire tampon préexistant. |
STRSAFE_NULL_ON_FAILURE | Si cet indicateur est défini et que la fonction échoue, la mémoire tampon de destination est définie sur une chaîne vide (TEXT(« »)). Cette opération remplace tout contenu de mémoire tampon préexistant. |
STRSAFE_NO_TRUNCATION |
Si cet indicateur est défini et que la fonction retourne STATUS_BUFFER_OVERFLOW :
|
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. Si STRSAFE_NO_TRUNCATION est défini, consultez le paramètre dwFlags pour plus d’informations. |
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 :
|
Remarques
RtlStringCbCopyExA et RtlStringCbCopyExW doivent être utilisés à la place des fonctions suivantes :
- strcpy
- wcscpy
La taille, en octets, de la mémoire tampon de destination est fournie à RtlStringCbCopyExA et RtlStringCbCopyExW pour s’assurer qu’ils n’écrivent pas au-delà de la fin de la mémoire tampon.
RtlStringCbCopyEx ajoute aux fonctionnalités de RtlStringCbCopy en renvoyant un pointeur vers la fin de la chaîne de destination, ainsi que le nombre d’octets inutilisés dans cette chaîne. Les indicateurs peuvent être passés à la fonction pour un contrôle supplémentaire.
Utilisez RtlStringCbCopyExW pour gérer les chaînes Unicode et RtlStringCbCopyExA 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 » | RtlStringCbCopyExW |
char | "chaîne" | RtlStringCbCopyExA |
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 avoir la valeur NULL , sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini, auquel cas l’un ou l’autre peut avoir la valeur NULL. Si pszDest a la valeur NULL, pszSrc doit avoir la valeur NULL ou pointer vers une chaîne vide.
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 |