Fonction StringCbCatNA (strsafe.h)

Article
03/02/2024

Concatène le nombre spécifié d’octets d’une chaîne à une autre chaîne. La taille, en octets, 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.

StringCbCatN remplace les fonctions suivantes :

Syntaxe

STRSAFEAPI StringCbCatNA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
  [in]      size_t         cbToAppend
);

Paramètres

[in, out] pszDest

Type : LPTSTR

La mémoire tampon de destination, qui contient la chaîne qui doit être concaténée sur pszSrc, et reçoit la chaîne résultante. La chaîne au niveau pszSrc, jusqu’aux octets cbMaxAppend , est ajoutée à la fin de la chaîne à pszDest.

[in] cbDest

Type : size_t

Taille de la mémoire tampon de destination, en octets. Cette valeur doit prendre en compte la longueur de pszSrc plus la longueur de pszDest ou cbMaxAppend (selon la plus petite des deux) plus le caractère null de fin. Le nombre maximal d’octets autorisé est STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Type : LPCTSTR

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

[in] cbToAppend

Type : size_t

Nombre maximal d’octets à ajouter à pszDest.

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é 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 cbDest est supérieure à la valeur maximale autorisée, 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 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, StringCbCatN 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. StringCbCatN 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. Consultez StringCbCatNEx si vous avez besoin de gérer des valeurs de pointeur de chaîne null.

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

String, type de données	Littéral de chaîne	Fonction
char	"chaîne"	StringCbCatNA
TCHAR	TEXT(« string »)	StringCbCatN
WCHAR	L"string »	StringCbCatNW

Notes

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

StringCbCat

StringCbCatNEx

StringCchCatN

Partager via