StringCchCopyNW, fonction (strsafe.h)
Copie le nombre spécifié de caractères d’une chaîne vers une autre. La taille de la mémoire tampon de destination est fournie à la fonction pour s’assurer que StringCchCopyN n’écrit pas au-delà de la fin de cette mémoire tampon.
StringCchCopyN remplace les fonctions suivantes :
Syntaxe
STRSAFEAPI StringCchCopyNW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZWCH pszSrc,
[in] size_t cchToCopy
);
Paramètres
[out] pszDest
Type : LPTSTR
Mémoire tampon de destination, qui reçoit les caractères copiés.
[in] cchDest
Type : size_t
Taille de pszDest, en caractères. Cette valeur doit être suffisamment grande pour contenir les caractères copiés (la longueur de pszSrc ou la valeur de cchSrc, selon la valeur la plus petite), plus 1 pour prendre en compte le 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 lisible jusqu’aux caractères cchSrc ou à un terminateur Null, selon ce qui se produit en premier.
[in] cchToCopy
Type : size_t
Nombre maximal de caractères à copier de pszSrc à pszDest.
Valeur retournée
Type : HRESULT
Cette fonction peut retourner l’une des valeurs suivantes. Il est fortement 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, les caractères ont été copiés à partir de pszSrc sans troncation, et la mémoire tampon de destination résultante est terminée par null. |
|
La valeur de cchDest est supérieure à STRSAFE_MAX_CCH, ou la mémoire tampon de destination est déjà pleine. |
|
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 d’échec. |
Notez que cette fonction retourne une valeur HRESULT , contrairement aux fonctions qu’elle remplace.
Remarques
StringCchCopyN 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. StringCchCopyN 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.
Bien que cette routine soit destinée à remplacer strncpy, il existe des différences de comportement. Si cchSrc est supérieur au nombre de caractères dans pszSrc, StringCchCopyN (contrairement à strncpy) ne continue pas à remplir pszDest avec des caractères null tant que les caractères cchSrc n’ont pas été copiés.
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 être NULL. Consultez StringCchCopyNEx si vous avez besoin de la gestion des valeurs de pointeur de chaîne Null.
StringCchCopyN 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, comme indiqué dans le tableau suivant.
| String, type de données | Littéral de chaîne | Fonction |
|---|---|---|
| char | "chaîne" | StringCchCopyNA |
| TCHAR | TEXT(« string ») | StringCchCopyN |
| WCHAR | L"string » | StringCchCopyNW |
Notes
L’en-tête strsafe.h définit StringCchCopyN 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. La combinaison 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