StringCchCatNA, fonction (strsafe.h)

Article
11/20/2024

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 au-delà de la fin de cette mémoire tampon.

StringCchCatN remplace les fonctions suivantes :

Syntaxe

STRSAFEAPI StringCchCatNA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cchDest,
  [in]      STRSAFE_PCNZCH pszSrc,
  [in]      size_t         cchToAppend
);

Paramètres

[in, out] pszDest

Type : LPTSTR

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, jusqu’à caractères cchMaxAppend, 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 ou cchMaxAppend (selon la valeur la plus petite). Pour cette somme, ajoutez 1 pour prendre en compte le caractère null de fin. Le nombre maximal de caractères autorisés 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.

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
S_OK	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 null.
STRSAFE_E_INVALID_PARAMETER	La valeur de 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 concaténation 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

Par rapport aux fonctions qu’il remplace, StringCchCatN 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. StringCchCatN 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.

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 StringCchCatNEx si vous avez besoin de la gestion des valeurs de pointeur de chaîne Null.

stringCchCatN 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.

Type de données de chaîne	Littéral de chaîne	Fonction
char	« string »	StringCchCatNA
TCHAR	TEXT(« string »)	StringCchCatN
WCHAR	L"string »	stringCchCatNW

Note

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

StringCbCatN

StringCchCat

StringCchCatNEx

Partager via