StringCchCatNExA, fonction (strsafe.h)
Concatène le nombre spécifié de caractères d’une chaîne à une autre chaîne. 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.
StringCchCatNEx ajoute à la fonctionnalité de StringCchCatN 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.
StringCchCatNEx remplace les fonctions suivantes :
Syntaxe
STRSAFEAPI StringCchCatNExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cchToAppend,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
Paramètres
[in, out] pszDest
Type : LPTSTR
La mémoire tampon de destination, qui contient la chaîne qui doit être concaténée avec pszSrc, et reçoit la chaîne résultante entière. La chaîne à pszSrc est ajoutée à la fin de la chaîne à pszDest.
[in] cchDest
Type : size_t
Taille de la mémoire tampon de destination, en caractères. Cette valeur doit être égale à la longueur de pszSrc plus la longueur de pszDest 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 concaténée à la fin de pszDest. Cette chaîne doit être terminée par null.
[in] cchToAppend
Type : size_t
Nombre maximal de caractères à ajouter à 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 ajoutées à 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 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 chaînes ont été concaténées sans troncation et la mémoire tampon de destination résultante est terminée par un caractère Null. |
|
La valeur dans cchDest est supérieure à STRSAFE_MAX_CCH, un indicateur non valide a été passé, ou il existe des différences entre la taille du pszDest, cchDest et la quantité de matériau à ajouter dans pszSrc. |
|
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
Par rapport aux fonctions qu’il remplace, StringCchCatNEx fournit un traitement supplémentaire pour la 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. StringCchCatNEx se termine toujours par la valeur 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.
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.
StringCchCatNEx 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.
| String, type de données | Littéral de chaîne | Fonction |
|---|---|---|
| char | "chaîne" | StringCchCatNExA |
| TCHAR | TEXT(« string ») | StringCchCatNEx |
| WCHAR | L"string » | StringCchCatNExW |
Notes
L’en-tête strsafe.h définit StringCchCatNEx 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