StringCbCatNExW, fonction (strsafe.h)

Concatène le nombre spécifié d’octets 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.

StringCbCatNEx est un remplacement des fonctions suivantes :

• strncat
• strNCat

StringCbCatNEx ajoute aux fonctionnalités de StringCbCatN en retournant un pointeur à la fin de la chaîne de destination, ainsi que le nombre d’octets laissés inutilisés dans cette chaîne. Les indicateurs peuvent également être passés à la fonction pour un contrôle supplémentaire.

Syntaxe

STRSAFEAPI StringCbCatNExW(
  [in, out]       STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cbDest,
  [in]            STRSAFE_PCNZWCH pszSrc,
  [in]            size_t          cbToAppend,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcbRemaining,
  [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 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] 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 plus les octets utilisés pour le caractère null de fin. Le nombre maximal d’octets autorisés 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 doit être terminée par null.

[in] cbToAppend

Type : size_t

Nombre maximal d’octets à ajouter à pszDest.

[out, optional] ppszDestEnd

Type : LPTSTR*

Adresse d’un pointeur à la fin de pszDest. Si ppszDestEnd n’est pas NULL et que toutes les 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] pcbRemaining

Type : size_t*

Nombre d’octets inutilisés dans pszDest, y compris ceux utilisés pour la fin du caractère null. Si de personnalisation est 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 suivant le caractère null de fin.
STRSAFE_IGNORE_NULLS 0x00000100	Traitez null pointeurs de chaîne comme des chaînes vides (TEXT(«  »)).
STRSAFE_FILL_ON_FAILURE 0x00000400	Si la fonction échoue, l’octet faible de dwFlags (0) est utilisé pour remplir l’intégralité de la mémoire tampon pszDest, et la mémoire tampon est terminée par null. En cas d’échec 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 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 touché. Rien n’est ajouté au contenu d’origine.

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 dans cbDest est supérieure à STRSAFE_MAX_CCH * sizeof(TCHAR), un indicateur non valide a été passé ou il existe des différences entre la taille du pszDest, cbDest, et la quantité de matériel à ajouter dans pszSrc.
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 d’échec.

 

Notez que cette fonction retourne une valeur HRESULT, contrairement aux fonctions qu’elle remplace.

Remarques

Par rapport aux fonctions qu’il remplace, StringCbCatNEx 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. StringCbCatNEx 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, 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 valeurs NULL sont ignorées.

StringCbCatNEx 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 »	StringCbCatNExA
TCHAR	TEXT(« string »)	StringCbCatNEx
WCHAR	L"string »	StringCbCatNExW

 

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

StringCbCatEx

StringCbCatN

StringCchCatNEx