StringCbCopyNA, fonction (strsafe.h)

  • Article

Copie le nombre spécifié d’octets d’une chaîne à une autre. La taille de la mémoire tampon de destination est fournie à la fonction pour s’assurer qu’elle n’écrit pas après la fin de cette mémoire tampon.

StringCbCopyN remplace les 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, selon la valeur la plus petite) et prendre également en compte le caractère null de fin. Le nombre maximal de caractères autorisé 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 vers 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
S_OK
 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 un caractère Null.
STRSAFE_E_INVALID_PARAMETER
 La valeur dans cbDest est supérieure STRSAFE_MAX_CCH * sizeof(TCHAR)à , ou la mémoire tampon de destination est déjà saturée.
STRSAFE_E_INSUFFICIENT_BUFFER
 L’opération de copie a échoué en raison d’un espace de mémoire tampon insuffisant. La mémoire tampon de destination contient une version tronquée et terminée par un caractère Null du résultat prévu. Dans les situations où la troncation est acceptable, cela ne peut 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

StringCbCopyN 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. 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 tant que les octets cbSrc 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 StringCbCopyNEx si vous avez besoin de gérer des valeurs de pointeur de chaîne null.

StringCbCopyN 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" StringCbCopyNA
TCHAR TEXT(« string ») StringCbCopyN
WCHAR L"string » StringCbCopyNW
 

Notes

L’en-tête strsafe.h définit StringCbCopyN en tant qu’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

Condition requise Valeur
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

StringCbCopy

StringCbCopyNEx

StringCchCopyN