Partager via

Fonction RtlStringCchCatExA (ntstrsafe.h)

  • Article

Les fonctions RtlStringCchCatExW et RtlStringCchCatExA concatènent deux chaînes comptées en caractères.

Syntaxe

NTSTRSAFEDDI RtlStringCchCatExA(
  [in, out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]                size_t          cchDest,
  [in]                NTSTRSAFE_PCSTR pszSrc,
  [out, optional]     NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional]     size_t          *pcchRemaining,
  [in]                DWORD           dwFlags
);

Paramètres

[in, out, optional] 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ée. En sortie, il s’agit de la mémoire tampon de destination qui contient l’intégralité de la chaîne résultante. La chaîne à pszSrc est ajoutée à la fin de la chaîne à pszDest et se termine par un caractère Null. Le pointeur pszDest peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags .

[in] cchDest

Taille de la mémoire tampon de destination, en caractères. Le nombre maximal de caractères autorisés est NTSTRSAFE_MAX_CCH. Si pszDest est NULL, cchDest doit être égal à zéro.

[in] pszSrc

Pointeur vers une chaîne terminée par null. Cette chaîne est concaténée à la fin de la chaîne contenue dans la mémoire tampon à pszDest. Le pointeur pszSrc peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags .

[out, optional] ppszDestEnd

Si l’appelant fournit un pointeur d’adresse nullNULL, une fois l’opération de concaténation terminée, la fonction charge cette adresse avec un pointeur vers la marque de fin de chaîne null résultante de la mémoire tampon de destination.

[out, optional] pcchRemaining

Si l’appelant fournit un pointeur d’adresse null nonNULL, la fonction charge l’adresse avec le nombre de caractères inutilisés qui se trouvent dans la mémoire tampon vers laquelle pointe pszDest, y compris le caractère null de fin.

[in] dwFlags

Un ou plusieurs indicateurs et, éventuellement, un octet de remplissage. Les indicateurs sont définis comme suit :

Valeur Signification
STRSAFE_FILL_BEHIND_NULL Si la fonction est définie et réussit, l’octet faible de dwFlags est utilisé pour remplir la partie de la mémoire tampon de destination qui suit le caractère null de fin.
STRSAFE_IGNORE_NULLS Si la valeur est définie, pszDest ou pszSrc, ou les deux, peut être NULL. NULLpszSrc pointeurs sont traités comme des chaînes vides (TEXT(«  »)), qui peuvent être copiées. NULLpszDest pointeurs ne peuvent pas recevoir de chaînes vides.
STRSAFE_FILL_ON_FAILURE Si la fonction échoue et que la fonction échoue, l’octet faible de dwFlags est utilisé pour remplir la mémoire tampon de destination entière et la mémoire tampon est terminée par null. Cette opération remplace tout contenu de mémoire tampon préexistant.
STRSAFE_NULL_ON_FAILURE Si la fonction échoue et que la fonction échoue, la mémoire tampon de destination est définie sur une chaîne vide (TEXT(«  »)). Cette opération remplace tout contenu de mémoire tampon préexistant.
STRSAFE_NO_TRUNCATION

Si la fonction est définie et retourne STATUS_BUFFER_OVERFLOW :

  • Si STRSAFE_FILL_ON_FAILURE est également spécifié, STRSAFE_NO_TRUNCATION remplit la mémoire tampon de destination en conséquence.
  • Sinon, la mémoire tampon de destination n’est pas modifiée.

Valeur de retour

La fonction retourne l’une des valeurs NTSTATUS répertoriées dans le tableau suivant. Pour plus d’informations sur la façon de tester des valeurs NTSTATUS, consultez Using NTSTATUS Values.

Retourner le code Description
STATUS_SUCCESS Cette réussite état 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 état signifie que l’opération n’a pas été terminée en raison d’un espace insuffisant dans la mémoire tampon de destination. Si STRSAFE_NO_TRUNCATION est défini, consultez le paramètre dwFlags pour plus d’informations.
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 le paragraphe suivant.

La fonction retourne la valeur STATUS_INVALID_PARAMETER lorsque :

  • Un indicateur non valide a été spécifié.
  • La valeur de 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 a été présent sans l’indicateur de STRSAFE_IGNORE_NULLS.
  • 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.
  • Le pointeur de la mémoire tampon de destination était NULL, ou sa longueur était égale à zéro, mais une chaîne source de longueur différente de zéro était présente.

Remarques

RtlStringCchCatExW et RtlStringCchCatExA doivent être utilisés au lieu des fonctions suivantes :

  • strcat
  • wcscat

La taille, en caractères, de la mémoire tampon de destination est fournie pour vous assurer que RtlStringCchCatExW et RtlStringCchCatExA n’écrivez pas au-delà de la fin de la mémoire tampon.

RtlStringCchCatExW et RtlStringCchCatExA ajouter aux fonctionnalités de RtlStringCchCat en retournant un pointeur à la fin de la chaîne de destination, ainsi que le nombre de caractères laissés inutilisés dans la mémoire tampon de destination. Les indicateurs peuvent être passés à la fonction pour un contrôle supplémentaire.

Utilisez RtlStringCchCatExW pour gérer les chaînes Unicode et RtlStringCchCatExA pour gérer les chaînes ANSI. Le formulaire que vous utilisez dépend de vos données.

Type de données de chaîne Littéral de chaîne Fonction
WCHAR L"string » RtlStringCchCatExW
char « string » RtlStringCchCatExA

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 peut être NULL, sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini, auquel cas ou les deux peuvent être NULL. Si pszDest est NULL, pszSrc doit être NULL ou pointer vers une chaîne vide.

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

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