Fonction RtlStringCbCatNA (ntstrsafe.h)

Article
05/03/2024

Les fonctions RtlStringCbCatNW et RtlStringCbCatNA concatènent deux chaînes d’octets comptées tout en limitant la taille de la chaîne ajoutée.

Syntaxe

NTSTRSAFEDDI RtlStringCbCatNA(
  [in, out] NTSTRSAFE_PSTR pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
            size_t         cbToAppend
);

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 vers 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, jusqu’aux octets cbToAppend , est ajoutée à la fin de la chaîne à pszDest et terminée par un caractère null.

[in] cbDest

Taille de la mémoire tampon de destination, en octets. La mémoire tampon doit être suffisamment grande pour inclure les chaînes et le caractère null de fin.

Pour les chaînes Unicode, le nombre maximal d’octets est NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Pour les chaînes ANSI, le nombre maximal d’octets est NTSTRSAFE_MAX_CCH * sizeof(char).

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

cbToAppend

Nombre maximal d’octets à ajouter à la chaîne contenue dans la mémoire tampon au niveau 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	Ce succès status signifie que les données sources étaient présentes, que les chaînes ont été concaténées 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 de concaténation ne s’est pas terminée 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.
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 cbDest 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. 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

Ce succès status signifie que les données sources étaient présentes, que les chaînes ont été concaténées 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 de concaténation ne s’est pas terminée 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.

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

RtlStringCbCatNW et RtlStringCbCatNA doivent être utilisés à la place des fonctions suivantes :

strncat
wcsncat

La taille, en octets, de la mémoire tampon de destination est fournie à RtlStringCbCatNW et RtlStringCbCatNA pour s’assurer qu’ils n’écrivent pas au-delà de la fin de la mémoire tampon.

Utilisez RtlStringCbCatNW pour gérer les chaînes Unicode et RtlStringCbCatNA 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 »	RtlStringCbCatNW
char	"chaîne"	RtlStringCbCatNA

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

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

RtlStringCbCatNEx

RtlStringCchCatN

Partager via