StringCbCopyNA, fonction (strsafe.h)
Copie le nombre spécifié d’octets d’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 cette mémoire tampon.
stringCbCopyN est un remplacement des fonctions suivantes :
Syntaxe
STRSAFEAPI StringCbCopyNA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cbToCopy
);
Paramètres
[out] pszDest
Type : LPTSTR
Mémoire tampon de destination, qui reçoit les caractères copiés.
[in] cbDest
Type : size_t
Taille de pszDest, en octets. Cette valeur doit être suffisamment grande pour contenir les octets copiés (la taille de pszSrc ou la valeur de cbSrc, le cas où il est plus petit) et compte également pour le caractère null de fin. Le nombre maximal de caractères autorisés est STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszSrc
Type : LPCTSTR
Chaîne source. Cette chaîne doit être terminée par null.
[in] cbToCopy
Type : size_t
Nombre maximal d’octets à copier de pszSrc à pszDest.
Valeur de retour
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.
| Retourner le code | Description |
|---|---|
|
Les données sources étaient présentes, les données ont été copiées à partir de pszSrc sans troncation, et la mémoire tampon de destination résultante est terminée par null. |
|
La valeur de cbDest est supérieure à STRSAFE_MAX_CCH * sizeof(TCHAR), 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
StringCbCopyN 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. StringCbCopyN 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 cbSrc est supérieur au nombre d’octets dans pszSrc, StringCbCopyN( contrairement à strncpy) ne continue pas à remplir pszDest avec des caractères null jusqu’à ce que octets aient été copiés.
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. Consultez StringCbCopyNEx si vous avez besoin de la gestion des valeurs de pointeur de chaîne Null.
StringCbCopyN 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.
| Type de données de chaîne | Littéral de chaîne | Fonction |
|---|---|---|
| char | « string » | stringCbCopyNA |
| TCHAR | TEXT(« string ») | StringCbCopyN |
| WCHAR | L"string » | StringCbCopyNW |
Note
L’en-tête strsafe.h définit StringCbCopyN 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