Partager via


StringCchCopyNExW, fonction (strsafe.h)

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 s’assurer qu’elle n’écrit pas après la fin de cette mémoire tampon.

StringCchCopyNEx ajoute à la fonctionnalité de StringCchCopyN en retournant un pointeur vers la fin de la chaîne de destination, ainsi que le nombre de caractères inutilisés dans cette chaîne. Des indicateurs peuvent également être passés à la fonction pour un contrôle supplémentaire.

StringCchCopyNEx remplace les fonctions suivantes :

Syntaxe

STRSAFEAPI StringCchCopyNExW(
  [out]           STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cchDest,
  [in]            STRSAFE_PCNZWCH pszSrc,
  [in]            size_t          cchToCopy,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags
);

Paramètres

[out] pszDest

Type : LPTSTR

Mémoire tampon de destination, qui reçoit la chaîne copiée.

[in] cchDest

Type : size_t

Taille de pszDest, en caractères. Cette valeur doit être au moins 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é 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.

[out, optional] ppszDestEnd

Type : LPTSTR*

Adresse d’un pointeur vers la fin de pszDest. Si ppszDestEnd n’a pas la valeur NULL et que des données sont copiées dans la mémoire tampon de destination, cela pointe vers le caractère null de fin à la fin de la chaîne.

[out, optional] pcchRemaining

Type : size_t*

Nombre de caractères inutilisés dans pszDest, y compris le caractère null de fin. Si pcchRemaining a la valeur NULL, le nombre n’est pas conservé ou retourné.

[in] dwFlags

Type : DWORD

Une ou plusieurs des valeurs suivantes.

Valeur Signification
STRSAFE_FILL_BEHIND_NULL
0x00000200
Si la fonction réussit, l’octet faible de dwFlags (0) est utilisé pour remplir la partie non initialisée de pszDest après le caractère null de fin.
STRSAFE_IGNORE_NULLS
0x00000100
Traitez les pointeurs de chaîne NULL comme des chaînes vides (TEXT(«  »)).
STRSAFE_FILL_ON_FAILURE
0x00000400
En cas d’échec de la fonction, l’octet faible de dwFlags (0) est utilisé pour remplir la mémoire tampon pszDest entière, et la mémoire tampon est terminée par la valeur Null. En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne tronquée retournée est remplacée.
STRSAFE_NULL_ON_FAILURE
0x00000800
Si la fonction échoue, pszDest est défini sur une chaîne vide (TEXT(«  »)). En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne tronquée est remplacée.
STRSAFE_NO_TRUNCATION
0x00001000
Comme dans le cas de STRSAFE_NULL_ON_FAILURE, si la fonction échoue, pszDest est défini sur une chaîne vide (TEXT(«  »)). En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne tronquée est remplacée.

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, entièrement copiées sans troncation, et la mémoire tampon de destination résultante est terminée par null.
STRSAFE_E_INVALID_PARAMETER
PszDest ou pszSrc est supérieur à STRSAFE_MAX_CCH, pszDest a la valeur NULL quand des données sources sont présentes à copier, ou un indicateur non valide a été passé.
STRSAFE_E_INSUFFICIENT_BUFFER
L’opération de copie a échoué en raison d’un espace de mémoire tampon insuffisant. Selon la valeur de dwFlags, la mémoire tampon de destination peut contenir 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

StringCchCopyNEx 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. StringCchCopyNEx 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, StringCchCopyNEx( 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 avoir la valeur NULL , sauf si l’indicateur STRSAFE_IGNORE_NULLS est spécifié, auquel cas les deux peuvent être NULL. Toutefois, une erreur due à un espace insuffisant peut toujours être retournée même si les valeurs NULL sont ignorées.

StringCchCopyNEx peut être utilisé dans 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" StringCchCopyNExA
TCHAR TEXT(« string ») StringCchCopyNEx
WCHAR L"string » StringCchCopyNExW
 

Notes

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

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

StringCbCopyNEx

StringCchCopyN