StringCchCopyExA, fonction (strsafe.h)

Article
11/20/2024

Copie une chaîne vers une autre. La taille de la mémoire tampon de destination est fournie à la fonction pour s’assurer qu’elle n’écrit pas au-delà de la fin de la mémoire tampon.

StringCchCopyEx ajoute aux fonctionnalités de StringCchCopy 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 également être passés à cette fonction pour un contrôle supplémentaire.

StringCchCopyEx est un remplacement des fonctions suivantes :

strcpy, wcscpy, _tcscpy
lstrcpy
StrCpy

Syntaxe

STRSAFEAPI StringCchCopyExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [in]            STRSAFE_LPCSTR pszSrc,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags
);

Paramètres

[out] pszDest

Type : LPTSTR

Mémoire tampon de destination, qui reçoit la chaîne copiée.

[in] cchDest

Type : size_t

Taille de la mémoire tampon de destination, en caractères. Cette valeur doit être égale à la longueur de pszSrc plus 1 pour tenir compte de la chaîne source copiée et du caractère null de fin. Le nombre maximal de caractères autorisés est STRSAFE_MAX_CCH.

[in] pszSrc

Type : LPCTSTR

Chaîne source. Cette chaîne doit être terminée par null.

[out, optional] ppszDestEnd

Type : LPTSTR*

Adresse d’un pointeur à la fin de pszDest. Si ppszDestEnd n’est pas NULL et que toutes les données sont copiées dans la mémoire tampon de destination, cela pointe vers le caractère null de fin à la fin de la chaîne.

[out, optional] pcchRemaining

Type : size_t*

Nombre de caractères inutilisés dans pszDest, y compris le caractère null de fin. Si pcchRemaining est NULL, le nombre n’est pas conservé ou retourné.

[in] dwFlags

Type : DWORD

Une ou plusieurs des valeurs suivantes.

Valeur	Signification
STRSAFE_FILL_BEHIND_NULL 0x00000200	Si la fonction réussit, l’octet faible de dwFlags (0) est utilisé pour remplir la partie non initialisée de pszDest suivant le caractère null de fin.
STRSAFE_IGNORE_NULLS 0x00000100	Traitez null pointeurs de chaîne comme des chaînes vides (TEXT(« »)). Cet indicateur est utile pour simuler des fonctions telles que lstrcpy.
STRSAFE_FILL_ON_FAILURE 0x00000400	Si la fonction échoue, l’octet faible de dwFlags (0) est utilisé pour remplir l’intégralité de la mémoire tampon pszDest, et la mémoire tampon est terminée par null. En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER, toute chaîne tronquée retournée est remplacée.
STRSAFE_NULL_ON_FAILURE 0x00000800	Si la fonction échoue, pszDest est défini sur une chaîne vide (TEXT(« »)). En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER, toute chaîne tronquée est remplacée.
STRSAFE_NO_TRUNCATION 0x00001000	Comme dans le cas de STRSAFE_NULL_ON_FAILURE, si la fonction échoue, pszDest est définie sur une chaîne vide (TEXT(« »)). En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER, toute chaîne tronquée est remplacée.

Valeur de retour

Type : HRESULT

Il est fortement recommandé d’utiliser les macros SUCCEEDED et FAILED pour tester la valeur de retour de cette fonction.

Retourner le code	Description
S_OK	Les données sources étaient présentes, entièrement copiées sans troncation, et la mémoire tampon de destination résultante est terminée par null.
STRSAFE_E_INVALID_PARAMETER	Soit pszDest est NULL lorsqu’il existe des données sources présentes à copier, ou qu’un indicateur non valide a été passé.
STRSAFE_E_INSUFFICIENT_BUFFER	L’opération de copie a échoué en raison d’un espace tampon insuffisant. Selon la valeur de dwFlags, la mémoire tampon de destination peut contenir une version tronquée et terminée par null du résultat prévu. Dans les situations où la troncation est acceptable, cela peut ne pas nécessairement être considéré comme une condition d’échec.

Notez que cette fonction retourne une valeur HRESULT, contrairement aux fonctions qu’elle remplace.

Remarques

Par rapport aux fonctions qu’il remplace, StringCchCopyEx fournit un traitement supplémentaire pour la gestion appropriée des mémoires tampons dans votre code. Une mauvaise gestion des mémoires tampons est impliquée dans de nombreux problèmes de sécurité qui impliquent des dépassements de mémoire tampon. StringCchCopyEx se termine toujours par null et ne dépasse jamais une mémoire tampon de destination valide, même si le contenu de la chaîne source change pendant l’opération.

Le comportement n’est pas défini si les chaînes pointées par pszSrc et pszDest chevauchent.

Ni pszSrc ni pszDest ne doit être NULL, sauf si l’indicateur STRSAFE_IGNORE_NULLS est spécifié, auquel cas les deux peuvent être NULL. Toutefois, une erreur due à un espace insuffisant peut toujours être retournée même si valeurs NULL sont ignorées.

StringCchCopyEx peut être utilisé dans sa forme générique ou dans ses formulaires plus spécifiques. Le type de données de la chaîne détermine la forme de cette fonction que vous devez utiliser.

Type de données de chaîne	Littéral de chaîne	Fonction
char	« string »	stringCchCopyExA
TCHAR	TEXT(« string »)	stringCchCopyEx
WCHAR	L"string »	StringCchCopyExW

Note

L’en-tête strsafe.h définit StringCchCopyEx comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows XP avec SP2 [applications de bureau \| Applications UWP]
serveur minimum pris en charge	Windows Server 2003 avec SP1 [applications de bureau \| Applications UWP]
plateforme cible	Windows
d’en-tête	strsafe.h

Voir aussi

de référence

StringCbCopyEx

StringCchCopy

Partager via