Partager via


Fonction RtlUnicodeStringCbCatStringN (ntstrsafe.h)

La fonction RtlUnicodeStringCbCatStringN concatène deux chaînes lorsque la chaîne de destination est contenue dans une structure UNICODE_STRING, tout en limitant la taille de la chaîne ajoutée.

Syntaxe

NTSTRSAFEDDI RtlUnicodeStringCbCatStringN(
  [in, out] PUNICODE_STRING  DestinationString,
  [in]      NTSTRSAFE_PCWSTR pszSrc,
  [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 (à l’exclusion de la valeur null de fin) 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] pszSrc

Pointeur fourni par l’appelant vers une chaîne terminée par null. Cette chaîne est concaténée à la fin de la chaîne de destination contenue dans la structure UNICODE_STRING vers laquelle DestinationStr ing pointe vers.

[in] cbToAppend

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

Valeur de retour

RtlUnicodeStringCbCatStringN retourne l’une des valeurs NTSTATUS suivantes.

Retourner le code Description
STATUS_SUCCESS
Cette réussite état signifie que les données sources étaient présentes, que les chaînes étaient 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 état signifie que l’opération de concaténation n’a pas été 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 état signifie que la fonction a reçu un paramètre d’entrée non valide. Pour plus d’informations, consultez la liste suivante.
 

RtlUnicodeStringCbCatStringN 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 des valeurs NTSTATUS, consultez Using NTSTATUS Values.

Remarques

La fonction RtlUnicodeStringCbCatStringN 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 n'pas mettre fin à la chaîne résultante avec une valeur de caractère Null (autrement dit, 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 pszSrc et DestinationString ne peuvent pas être NULL. Si vous devez gérer valeurs de pointeur NULL, utilisez la fonction RtlUnicodeStringCbCatStringNEx.

Pour plus d’informations sur les fonctions de chaîne sécurisée, consultez Using Safe String Functions.

Exigences

Exigence Valeur
client minimum pris en charge Disponible dans Windows XP avec Service Pack 1 (SP1) et versions ultérieures de Windows.
plateforme cible Bureau
d’en-tête ntstrsafe.h (include Ntstrsafe.h)
bibliothèque Ntstrsafe.lib
IRQL Si les chaînes manipulées résident toujours en mémoire, sinon PASSIVE_LEVEL

Voir aussi

RtlUnicodeStringCbCatStringNEx

RtlUnicodeStringCchCatStringN

UNICODE_STRING