Fonction RtlStringCchCatW (ntstrsafe.h)

Article
02/29/2024

Les fonctions RtlStringCchCatW et RtlStringCchCatA concatènent deux chaînes de caractères.

Syntaxe

NTSTRSAFEDDI RtlStringCchCatW(
  [in, out] NTSTRSAFE_PWSTR  pszDest,
  [in]      size_t           cchDest,
  [in]      NTSTRSAFE_PCWSTR pszSrc
);

Paramètres

[in, out] pszDest

Pointeur vers une mémoire tampon qui, lors de l’entrée, contient une chaîne terminée par null à laquelle pszSrc sera concaténé. Sur la sortie, il s’agit de la mémoire tampon de destination qui contient la chaîne résultante entière. La chaîne à pszSrc est ajoutée à la fin de la chaîne à pszDest et terminée par un caractère null.

[in] cchDest

Taille, en caractères, de la mémoire tampon de destination. Le nombre maximal de caractères autorisé est NTSTRSAFE_MAX_CCH.

[in] pszSrc

Pointeur vers une chaîne terminée par null. Cette chaîne sera concaténée à la fin de la chaîne contenue dans la mémoire tampon à pszDest.

Valeur retournée

La fonction retourne l’une des valeurs NTSTATUS répertoriées dans le tableau suivant. Pour plus d’informations sur le test des valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

Code de retour	Description
STATUS_SUCCESS	Cette réussite status signifie que les données sources étaient présentes, que la chaîne de sortie a été créée sans troncation et que la mémoire tampon de destination résultante est terminée par null.
STATUS_BUFFER_OVERFLOW	Cet avertissement status signifie que l’opération ne s’est pas terminée en raison d’un espace insuffisant dans la mémoire tampon de destination. La mémoire tampon de destination contient une version tronquée et terminée par null du résultat prévu.
STATUS_INVALID_PARAMETER	Cette erreur status signifie que la fonction a reçu un paramètre d’entrée non valide. Pour plus d’informations, consultez le paragraphe suivant. La fonction retourne la valeur STATUS_INVALID_PARAMETER lorsque : La valeur dans cchDest est supérieure à la taille maximale de la mémoire tampon. La mémoire tampon de destination était déjà pleine. Un pointeur NULL était présent. Le pointeur de la mémoire tampon de destination était NULL, mais la taille de la mémoire tampon n’était pas égale à zéro. La longueur de la mémoire tampon de destination était égale à zéro, mais une chaîne source de longueur différente de zéro était présente.

Code de retour

Description

STATUS_SUCCESS

Cette réussite status signifie que les données sources étaient présentes, que la chaîne de sortie a été créée sans troncation et que la mémoire tampon de destination résultante est terminée par null.

STATUS_BUFFER_OVERFLOW

Cet avertissement status signifie que l’opération ne s’est pas terminée en raison d’un espace insuffisant dans la mémoire tampon de destination. La mémoire tampon de destination contient une version tronquée et terminée par null du résultat prévu.

STATUS_INVALID_PARAMETER

Cette erreur status signifie que la fonction a reçu un paramètre d’entrée non valide. Pour plus d’informations, consultez le paragraphe suivant.

La fonction retourne la valeur STATUS_INVALID_PARAMETER lorsque :

La valeur dans cchDest est supérieure à la taille maximale de la mémoire tampon.
La mémoire tampon de destination était déjà pleine.
Un pointeur NULL était présent.
Le pointeur de la mémoire tampon de destination était NULL, mais la taille de la mémoire tampon n’était pas égale à zéro.
La longueur de la mémoire tampon de destination était égale à zéro, mais une chaîne source de longueur différente de zéro était présente.

Remarques

RtlStringCchCatW et RtlStringCchCatA doivent être utilisés à la place des fonctions suivantes :

strcat
wcscat

La taille, en caractères, de la mémoire tampon de destination est fournie pour garantir que RtlStringCchCatW et RtlStringCchCatA n’écrivent pas au-delà de la fin de la mémoire tampon.

Utilisez RtlStringCchCatW pour gérer les chaînes Unicode et RtlStringCchCatA pour gérer les chaînes ANSI. Le formulaire que vous utilisez dépend de vos données, comme indiqué dans le tableau suivant.

Type de données String	Littéral de chaîne	Fonction
WCHAR	L"string »	RtlStringCchCatW
char	"chaîne"	RtlStringCchCatA

Si pszSrc et pszDest pointent vers des chaînes qui se chevauchent, le comportement de la fonction n’est pas défini.

Ni pszSrc ni pszDest ne peuvent être NULL. Si vous devez gérer les valeurs de pointeur de chaîne NULL , utilisez RtlStringCchCatEx.

Pour plus d’informations sur les fonctions de chaîne sécurisée, consultez Utilisation des fonctions de chaîne sécurisée.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows XP avec Service Pack 1 (SP1) et versions ultérieures de Windows.
Plateforme cible	Desktop (Expérience utilisateur)
En-tête	ntstrsafe.h (inclure Ntstrsafe.h)
Bibliothèque	Ntstrsafe.lib
IRQL	Toutes les chaînes si manipulées résident toujours dans la mémoire, sinon PASSIVE_LEVEL

Voir aussi

RtlStringCbCat

RtlStringCchCatEx

RtlStringCchCatN

Partager via