Fonction StringCbCopyW (strsafe.h)
Copie une chaîne dans une autre. La taille de la mémoire tampon de destination est fournie à la fonction pour garantir qu’elle n’écrit pas au-delà de la fin de cette mémoire tampon.
StringCbCopy remplace les fonctions suivantes :
Syntaxe
STRSAFEAPI StringCbCopyW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_LPCWSTR pszSrc
);
Paramètres
[out] pszDest
Type : LPTSTR
Mémoire tampon de destination, qui reçoit la chaîne copiée.
[in] cbDest
Type : size_t
Taille de la mémoire tampon de destination, en octets. Cette valeur doit prendre en compte la longueur de pszSrc plus le caractère null de fin. Le nombre maximal d’octets autorisé est STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszSrc
Type : LPCTSTR
Pointeur vers une mémoire tampon contenant la chaîne source. Cette chaîne source doit être terminée par null.
Valeur retournée
Type : HRESULT
Cette fonction peut retourner l’une des valeurs suivantes. Il est vivement recommandé d’utiliser les macros SUCCEEDED et FAILED pour tester la valeur de retour de cette fonction.
| Code de retour | Description |
|---|---|
|
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. |
|
La valeur dans cbDest est inférieure sizeof(TCHAR) ou supérieure à la valeur maximale autorisée.
|
|
L’opération de copie a échoué 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. Dans les situations où la troncation est acceptable, cela peut ne pas nécessairement être considéré comme une condition de défaillance. |
Notez que cette fonction retourne une valeur HRESULT , contrairement aux fonctions qu’elle remplace.
Remarques
Par rapport aux fonctions qu’il remplace, StringCbCopy fournit un traitement supplémentaire pour une gestion appropriée de la mémoire tampon dans votre code. Une gestion médiocre de la mémoire tampon est impliquée dans de nombreux problèmes de sécurité qui impliquent des dépassements de mémoire tampon. StringCbCopy 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 se chevauchent.
Ni pszSrc ni pszDest ne doivent avoir la valeur NULL. Consultez StringCbCopyEx si vous avez besoin de gérer des valeurs de pointeur de chaîne null.
StringCbCopy peut être utilisé sous sa forme générique ou dans ses formes plus spécifiques. Le type de données de la chaîne détermine la forme de cette fonction que vous devez utiliser.
| String, type de données | Littéral de chaîne | Fonction |
|---|---|---|
| char | "chaîne" | StringCbCopyA |
| TCHAR | TEXT(« string ») | StringCbCopy |
| WCHAR | L"string » | StringCbCopyW |
Notes
L’en-tête strsafe.h définit StringCbCopy comme un 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.
Configuration requise
| Client minimal pris en charge | Windows XP avec SP2 [applications de bureau | Applications UWP] |
| Serveur minimal pris en charge | Windows Server 2003 avec SP1 [applications de bureau | Applications UWP] |
| Plateforme cible | Windows |
| En-tête | strsafe.h |
Voir aussi
Référence