Fonction RtlStringCchCopyExA (ntstrsafe.h)
Les fonctions RtlStringCchCopyExW et RtlStringCchCopyExA copient une chaîne comptée en caractères dans une mémoire tampon.
Syntaxe
NTSTRSAFEDDI RtlStringCchCopyExA(
[out, optional] NTSTRSAFE_PSTR pszDest,
[in] size_t cchDest,
[in, optional] NTSTRSAFE_PCSTR pszSrc,
[out, optional] NTSTRSAFE_PSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[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 à pszDest et se termine par un caractère Null. Le pointeur pszDest peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags .
[in] cchDest
Taille de la mémoire tampon de destination, en caractères. Le nombre maximal de caractères autorisés est NTSTRSAFE_MAX_CCH. Si pszDest est NULL, cchDest doit être égal à zéro.
[in, optional] pszSrc
Pointeur vers une chaîne terminée par null fournie par l’appelant. Le pointeur pszSrc
[out, optional] ppszDestEnd
Si l’appelant fournit un pointeur d’adresse NULL non
[out, optional] pcchRemaining
Si l’appelant fournit un pointeur d’adresse null non
[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. NULLpszSrc pointeurs sont traités comme des chaînes vides (TEXT(« »)), qui peuvent être copiées. NULLpszDest pointeurs 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 la mémoire tampon de destination entière, 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 de retour
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 des valeurs NTSTATUS, consultez Using NTSTATUS Values.
Retourner le code | Description |
---|---|
STATUS_SUCCESS | Cette réussite état 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 état signifie que l’opération de copie n’a pas été terminée en raison d’un espace insuffisant dans la mémoire tampon de destination. Si STRSAFE_NO_TRUNCATION est défini dans dwFlags, consultez le paramètre dwFlags pour plus d’informations. |
STATUS_INVALID_PARAMETER |
Cette erreur état 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
RtlStringCchCopyExW et RtlStringCchCopyExA doivent être utilisés au lieu des fonctions suivantes :
- strcpy
- wcscpy
La taille, en caractères, de la mémoire tampon de destination est fournie à RtlStringCchCopyExW et RtlStringCchCopyExA pour s’assurer qu’ils n’écrivent pas au-delà de la fin de la mémoire tampon.
RtlStringCchCopyExW et RtlStringCchCopyExA ajouter aux fonctionnalités de RtlStringCchCopy en retournant un pointeur à la fin de la chaîne de destination, ainsi que le nombre de caractères laissés inutilisés dans cette chaîne. Les indicateurs peuvent être passés à la fonction pour un contrôle supplémentaire. Utilisez RtlStringCchCopyExW pour gérer les chaînes Unicode et RtlStringCchCopyExA 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 de chaîne | Littéral de chaîne | Fonction |
---|---|---|
WCHAR | L"string » | RtlStringCchCopyExW |
char | « string » | RtlStringCchCopyExA |
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 peut être NULL, sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini, auquel cas ou les deux peuvent être NULL. Si pszDest est NULL, pszSrc doit être NULL ou pointer vers une chaîne vide.
Pour plus d’informations sur les fonctions de chaîne sécurisée, consultez Utilisation de fonctions de chaîne sécurisée.
Exigences
Exigence | Valeur |
---|---|
client minimum pris en charge | Disponible dans Windows XP avec Service Pack 1 (SP1) et versions ultérieures de Windows. |
plateforme cible | Bureau |
d’en-tête | ntstrsafe.h (include Ntstrsafe.h) |
bibliothèque | Ntstrsafe.lib |
IRQL | Si les chaînes manipulées résident toujours en mémoire, sinon PASSIVE_LEVEL |