Fonction RtlStringCbCatNExA (ntstrsafe.h)

  • Article

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

Syntaxe

NTSTRSAFEDDI RtlStringCbCatNExA(
  [in, out, optional] NTSTRSAFE_PSTR pszDest,
  [in]                size_t         cbDest,
  [in, optional]      STRSAFE_PCNZCH pszSrc,
                      size_t         cbToAppend,
  [out, optional]     NTSTRSAFE_PSTR *ppszDestEnd,
  [out, optional]     size_t         *pcbRemaining,
  [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é. En 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’à cbMaxAppend octets, est ajoutée à la fin de la chaîne à pszDest et terminée par un caractère null. Le pointeur pszDest peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

[in] cbDest

Taille de la mémoire tampon de destination, en octets. La mémoire tampon doit être suffisamment grande pour inclure à la fois des 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)

Si pszDest a la valeur NULL, cbDest doit être égal à zéro.

[in, optional] 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. Le pointeur pszSrc peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

cbToAppend

Nombre maximal d’octets à ajouter à pszDest.

[out, optional] ppszDestEnd

Si l’appelant fournit un pointeur d’adresse non NULL , 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] pcbRemaining

Si l’appelant fournit un pointeur d’adresse non NULL , la fonction charge l’adresse avec le nombre d’octets inutilisés qui se trouvent dans la mémoire tampon pointée par pszDest, y compris les octets utilisés pour 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 cet indicateur est défini et que la fonction 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 cet indicateur est défini, pszDest ou pszSrc, ou les deux, peuvent être NULL. Les pointeurs pszSrcNULL sont traités comme des chaînes vides (TEXT(«  »)), qui peuvent être copiées. Les pointeurs pszDestNULL ne peuvent pas recevoir de chaînes vides.
STRSAFE_FILL_ON_FAILURE Si cet indicateur est défini et que la fonction échoue, l’octet faible de dwFlags est utilisé pour remplir l’intégralité de la mémoire tampon de destination, 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 cet indicateur est défini 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 cet indicateur est défini et que la fonction 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 retournée

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 les 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 les chaînes ont été entièrement 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 copie n’a pas été effectué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 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 :

  • Un indicateur non valide a été spécifié.
  • 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 sans l’indicateur 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

RtlStringCbCatNExW et RtlStringCbCatNExA doivent être utilisés à la place des fonctions suivantes :

  • strncat
  • wcsncat

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

RtlStringCbCatNEx ajoute aux fonctionnalités de RtlStringCbCatN en retournant un pointeur vers la fin de la chaîne de destination, ainsi que le nombre d’octets inutilisés dans cette chaîne. Les indicateurs peuvent être passés à la fonction pour un contrôle supplémentaire.

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

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 avoir la valeur NULL , sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini, auquel cas l’un ou l’autre peut avoir la valeur NULL. Si pszDest a la valeur 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.

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 Toutes les chaînes si manipulées résident toujours en mémoire, sinon PASSIVE_LEVEL

Voir aussi