Fonction StringCchCopyNA (strsafe.h)

Article
08/26/2023

Copie le nombre spécifié de caractères d’une chaîne à une autre. La taille de la mémoire tampon de destination est fournie à la fonction pour garantir que StringCchCopyN n’écrit pas au-delà de la fin de cette mémoire tampon.

StringCchCopyN remplace les fonctions suivantes :

strncpy, wcsncpy, _tcsncpy

Syntaxe

STRSAFEAPI StringCchCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH 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 tenir compte du caractère null de fin. Le nombre maximal de caractères autorisé est STRSAFE_MAX_CCH.

[in] pszSrc

Type : LPCTSTR

Chaîne source. Cette chaîne doit être lisible jusqu’à des caractères cchSrc ou un terminateur null, selon la première éventualité.

[in] cchToCopy

Type : size_t

Nombre maximal de caractères à copier de pszSrc vers pszDest.

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
S_OK	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.
STRSAFE_E_INVALID_PARAMETER	La valeur dans cchDest est supérieure à STRSAFE_MAX_CCH ou la mémoire tampon de destination est déjà pleine.
STRSAFE_E_INSUFFICIENT_BUFFER	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

StringCchCopyN 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. 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 à ajouter 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 avoir la valeur NULL. Consultez StringCchCopyNEx si vous avez besoin de la gestion des valeurs de pointeur de chaîne null.

StringCchCopyN 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, 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 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

StringCbCopyN

StringCchCopy

StringCchCopyNEx

Partager via