Fonction RtlUnicodeStringCbCatN (ntstrsafe.h)

Article
03/01/2024

La fonction RtlUnicodeStringCbCatN concatène deux chaînes contenues dans UNICODE_STRING structures tout en limitant la taille de la chaîne copiée.

Syntaxe

NTSTRSAFEDDI RtlUnicodeStringCbCatN(
  [in, out] PUNICODE_STRING  DestinationString,
  [in]      PCUNICODE_STRING SourceString,
  [in]      size_t           cbToAppend
);

Paramètres

[in, out] DestinationString

Pointeur vers une structure UNICODE_STRING . Cette structure inclut une mémoire tampon qui, lors de l’entrée, contient une chaîne de destination vers laquelle la chaîne source sera concaténée. En sortie, cette mémoire tampon est la mémoire tampon de destination qui contient la chaîne résultante entière. La chaîne source est ajoutée à la fin de la chaîne de destination. Le nombre maximal d’octets dans la mémoire tampon de chaîne de la structure est NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

Pointeur vers une structure UNICODE_STRING . Cette structure inclut une mémoire tampon qui contient la chaîne source. Cette chaîne sera ajoutée à la fin de la chaîne de destination. Le nombre maximal d’octets dans la mémoire tampon de chaîne de la structure est NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] cbToAppend

Nombre maximal d’octets à ajouter à la chaîne décrite par le paramètre DestinationString .

Valeur retournée

RtlUnicodeStringCbCatN retourne l’une des valeurs NTSTATUS suivantes.

Code de retour	Description
STATUS_SUCCESS	Cette réussite 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 un caractère 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 un caractère 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 la liste suivante.

RtlUnicodeStringCbCatN retourne la valeur STATUS_INVALID_PARAMETER lorsque l’une des opérations suivantes se produit :

Le contenu de la structure UNICODE_STRING n’est pas valide.
La mémoire tampon de destination est déjà pleine.
Un pointeur de mémoire tampon est NULL.
La longueur de la mémoire tampon de destination est égale à zéro, mais une chaîne source de longueur différente de zéro est présente.
La valeur du paramètre cbToAppend est supérieure à NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Pour plus d’informations sur la façon de tester les valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

Remarques

La fonction RtlUnicodeStringCbCatN utilise la taille de la mémoire tampon de destination pour s’assurer que l’opération de concaténation n’écrit pas au-delà de la fin de la mémoire tampon. La fonction ne termine pas la chaîne résultante avec une valeur de caractère Null (c’est-à-dire avec zéro).

Si les chaînes source et de destination se chevauchent, le comportement de la fonction n’est pas défini.

Les pointeurs SourceString et DestinationString ne peuvent pas être NULL. Si vous devez gérer les valeurs du pointeur NULL , utilisez la fonction RtlUnicodeStringCbCatNEx .

Pour plus d’informations sur les fonctions de chaîne sécurisée, consultez Utilisation de 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 (include Ntstrsafe.h)
Bibliothèque	Ntstrsafe.lib
IRQL	PASSIVE_LEVEL

Voir aussi

RtlUnicodeStringCbCatNEx

RtlUnicodeStringCchCatN

UNICODE_STRING