Partager via

Fonction RtlUnicodeStringCbCopyStringNEx (ntstrsafe.h)

  • Article

La fonction RtlUnicodeStringCbCopyStringNEx copie une chaîne dans une structure UNICODE_STRING tout en limitant la taille de la chaîne copiée.

Syntaxe

NTSTRSAFEDDI RtlUnicodeStringCbCopyStringNEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            NTSTRSAFE_PCWSTR pszSrc,
  [in]            size_t           cbToCopy,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

Paramètres

[out] DestinationString

Facultatif. Pointeur vers une structure UNICODE_STRING qui reçoit la chaîne copiée. La chaîne vers laquelle pointe le paramètre pszSrc (à l’exception de la valeur null de fin) est copiée dans la mémoire tampon vers laquelle pointe la structure UNICODE_STRING du paramètre DestinationString. Le nombre maximal d’octets dans la chaîne est NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). DestinationString peut avoir la valeur NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

[in] pszSrc

facultatif. Pointeur vers la chaîne à copier. Ce pointeur peut avoir la valeur NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

[in] cbToCopy

Nombre d’octets à copier de la source vers la destination.

[out, optional] RemainingString

facultatif. Si l’appelant fournit un pointeur non NULL vers une structure UNICODE_STRING , la fonction définit le membre Buffer de cette structure à la fin de la chaîne concaténée, définit le membre Length de la structure sur zéro et définit le membre MaximumLength de la structure sur le nombre d’octets restant dans la mémoire tampon de destination. RemainingString peut avoir la valeur NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

[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 dernier caractère de la chaîne.
STRSAFE_IGNORE_NULLS Si cet indicateur est défini, le pointeur source ou de destination, ou les deux, peut avoir la valeur NULL. RtlUnicodeStringCbCopyStringNEx traite les pointeurs de mémoire tampon source NULL comme des chaînes vides (TEXT(«  »)), qui peuvent être copiés. Les pointeurs de mémoire tampon de destination NULL 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 inférieur de dwFlags est utilisé pour remplir l’intégralité de la mémoire tampon de destination. 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, le contenu de la mémoire tampon de destination sera défini sur une chaîne vide, même si STRSAFE_NULL_ON_FAILURE n’est pas défini. STRSAFE_FILL_BEHIND_NULL est ignoré.
STRSAFE_ZERO_LENGTH_ON_FAILURE Si cet indicateur est défini et que la fonction retourne STATUS_BUFFER_OVERFLOW, la longueur de la chaîne de destination est définie sur zéro octets.

Valeur retournée

RtlUnicodeStringCbCopyStringNEx retourne l’une des valeurs NTSTATUS suivantes.

Code de retour Description
STATUS_SUCCESS Ce succès status signifie que les données sources étaient présentes et que les chaînes ont été concaténées sans troncation.
STATUS_BUFFER_OVERFLOW Cet avertissement status signifie que l’opération de copie ne s’est pas terminée en raison d’un espace insuffisant dans la mémoire tampon de destination. Si STRSAFE_NO_TRUNCATION est défini dans dwFlags, la mémoire tampon de destination n’est pas modifiée. Si l’indicateur n’est pas défini, la mémoire tampon de destination contient une version tronquée de la chaîne copiée.
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.

RtlUnicodeStringCbCopyStringNEx retourne la valeur STATUS_INVALID_PARAMETER lorsque l’un des éléments suivants se produit :

  • Le contenu d’une structure de UNICODE_STRING n’est pas valide.
  • Un indicateur non valide est spécifié dans dwFlags.
  • La mémoire tampon de destination est déjà pleine.
  • Un pointeur de mémoire tampon est NULL et l’indicateur STRSAFE_IGNORE_NULLS n’est pas spécifié dans dwFlags.
  • Le pointeur de mémoire tampon de destination est NULL, mais la taille de la mémoire tampon n’est pas égale à zéro.
  • Le pointeur de mémoire tampon de destination est NULL ou sa longueur est égale à zéro, mais une chaîne source de longueur différente de zéro est présente.
  • La valeur du paramètre cbToCopy est supérieure à NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Pour plus d’informations sur le test des valeurs NTSTATUS, consultez Utilisation de valeurs NTSTATUS.

Remarques

La fonction RtlUnicodeStringCbCopyStringNEx utilise la taille de la mémoire tampon de destination pour s’assurer que l’opération de copie n’écrit pas au-delà de la fin de la mémoire tampon. Par défaut, la fonction n’arrête pas la chaîne résultante avec une valeur de caractère null (c’est-à-dire avec zéro). En option, l’appelant peut utiliser l’indicateur STRSAFE_FILL_BEHIND et une valeur d’octet de remplissage égale à zéro pour terminer null une chaîne résultante qui n’occupe pas la mémoire tampon de destination entière.

RtlUnicodeStringCbCopyStringNEx ajoute aux fonctionnalités de la fonction RtlUnicodeStringCbCopyStringN en retournant une structure de UNICODE_STRING qui identifie la fin de la chaîne de destination et le nombre d’octets inutilisés dans cette chaîne. Vous pouvez passer des indicateurs RtlUnicodeStringCbCopyStringNEx pour un contrôle supplémentaire.

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 , sauf si l’indicateur STRSAFE_IGNORE_NULLS est défini dans dwFlags. Si STRSAFE_IGNORE_NULLS est défini, l’un de ces pointeurs ou les deux peuvent avoir la valeur NULL. Si le pointeur DestinationString a la valeur NULL, le pointeur pszSrc doit avoir la valeur NULL ou pointer vers une chaîne vide.

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 à partir de Windows XP avec Service Pack 1 (SP1).
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