Fonction RtlStringCchCopyExW (ntstrsafe.h)

  • Article

Les fonctions RtlStringCchCopyExW et RtlStringCchCopyExA copient une chaîne comptée de caractères dans une mémoire tampon.

Syntaxe

NTSTRSAFEDDI RtlStringCchCopyExW(
  [out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [in, optional]  NTSTRSAFE_PCWSTR pszSrc,
  [out, optional] NTSTRSAFE_PWSTR  *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 à 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] cchDest

Taille de la mémoire tampon de destination, en caractères. Le nombre maximal de caractères autorisé est NTSTRSAFE_MAX_CCH. Si pszDest a la valeur NULL, cchDest 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 le pointeur de fin de chaîne null résultant de la mémoire tampon de destination.

[out, optional] pcchRemaining

Si l’appelant fournit un pointeur d’adresse non NULL , la fonction charge l’adresse avec le nombre de caractères inutilisés qui se trouvent dans la mémoire tampon pointée vers pszDest, y compris 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 :

  • Si STRSAFE_FILL_ON_FAILURE est également spécifié, STRSAFE_NO_TRUNCATION remplit la mémoire tampon de destination en conséquence.
  • Sinon, le contenu de la mémoire tampon de destination sera défini sur une chaîne vide, même si STRSAFE_NULL_ON_FAILURE n’est pas défini. STRSAFE_FILL_BEHIND_NULL est ignoré.

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 dans dwFlags, la mémoire tampon de destination n’est pas modifiée. Si l’indicateur n’est pas défini, la mémoire tampon de destination contient une version tronquée de la chaîne créé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 :

  • Un indicateur non valide a été spécifié.
  • 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 sans l’indicateur STRSAFE_IGNORE_NULLS .
  • Le pointeur de la mémoire tampon de destination était NULL, mais la taille de la mémoire tampon n’était pas égale à zéro.
  • Le pointeur de la mémoire tampon de destination était NULL ou sa longueur était égale à zéro, mais une chaîne source de longueur différente de zéro était présente.

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 ajoutent aux fonctionnalités de RtlStringCchCopy en retournant un pointeur vers la fin de la chaîne de destination, ainsi que le nombre de caractères 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 String Littéral de chaîne Fonction
WCHAR L"string » RtlStringCchCopyExW
char "chaîne" 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 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 PASSIVE_LEVEL

Voir aussi