Fonction StringCchCatExA (strsafe.h)

Article
08/26/2023

Concatène une chaîne à une autre chaîne. La taille de la mémoire tampon de destination est fournie à la fonction pour garantir qu’elle n’écrit pas au-delà de la fin de cette mémoire tampon.

StringCchCatEx ajoute aux fonctionnalités de StringCchCat en renvoyant 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.

StringCchCatEx remplace les fonctions suivantes :

Syntaxe

STRSAFEAPI StringCchCatExA(
  [in, out]       STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [in]            STRSAFE_LPCSTR pszSrc,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags
);

Paramètres

[in, out] pszDest

Type : LPTSTR

Mémoire tampon de destination, qui contient la chaîne qui doit être concaténée sur pszSrc, et qui recevra 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 prendre en compte les deux chaînes et le caractère null de fin. Le nombre maximal de caractères autorisé est STRSAFE_MAX_CCH.

[in] pszSrc

Type : LPCTSTR

Chaîne source qui doit être concaténée à la fin de pszDest. Cette chaîne doit être terminée par null.

[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	Signification
STRSAFE_FILL_BEHIND_NULL 0x00000200	Si la fonction réussit, l’octet inférieur 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(« »)). Cet indicateur est utile pour émuler des fonctions telles que lstrcpy.
STRSAFE_FILL_ON_FAILURE 0x00000400	Si la fonction échoue, 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 null. En cas d’échec de STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne préexistante ou tronquée dans la mémoire tampon de destination 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 de STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne préexistante ou tronquée dans la mémoire tampon de destination est remplacée.
STRSAFE_NO_TRUNCATION 0x00001000	Si la fonction échoue, pszDest n’est pas modifié. Rien n’est ajouté au contenu d’origine.

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 chaînes ont été entièrement 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 dans cchDest est 0 ou 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. Selon la valeur de dwFlags, la mémoire tampon de destination peut contenir 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

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

StringCchCatEx 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"	StringCchCatExA
TCHAR	TEXT(« string »)	StringCchCatEx
WCHAR	L"string »	StringCchCatExW

Notes

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

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

StringCbCatEx

StringCchCat

StringCchCatNEx

Partager via