Fonction RtlStringCbCopyUnicodeStringEx (ntstrsafe.h)

Article
05/03/2024

La fonction RtlStringCbCopyUnicodeStringEx copie le contenu d’une structure UNICODE_STRING vers une destination spécifiée.

Syntaxe

NTSTRSAFEDDI RtlStringCbCopyUnicodeStringEx(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cbDest,
  [in]            PCUNICODE_STRING SourceString,
  [out]           NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcbRemaining,
  [in]            DWORD            dwFlags
);

Paramètres

[out] pszDest

Facultatif. Pointeur vers une mémoire tampon qui reçoit la chaîne copiée. La chaîne vers laquelle pointe la structure UNICODE_STRING du paramètre SourceString est copiée dans la mémoire tampon au niveau pszDest et terminée par un caractère Null. Ce pointeur peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

[in] cbDest

Taille, en octets, de la mémoire tampon de destination. La mémoire tampon doit être suffisamment grande pour la chaîne et le caractère null de fin. Le nombre maximal d’octets dans la mémoire tampon est NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

[in] SourceString

facultatif. Pointeur vers une structure UNICODE_STRING qui contient la chaîne à copier. Le nombre maximal d’octets dans la chaîne est NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). Ce pointeur peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags.

[out] ppszDestEnd

facultatif. Si l’appelant fournit un pointeur d’adresse non NULL , une fois l’opération de copie terminée, la fonction charge cette adresse avec un pointeur vers l’indicateur de fin de chaîne NULL résultant de la mémoire tampon de destination.

[out, optional] pcbRemaining

facultatif. 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 vers laquelle pointe 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, le pointeur source ou de destination, ou les deux, peuvent être NULL. RtlStringCbCopyUnicodeStringEx traite les pointeurs de mémoire tampon source NULL comme les chaînes vides (TEXT(« »)), qui peuvent être copiées. 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 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, le contenu de la mémoire tampon de destination est 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é.

Valeur retournée

RtlStringCbCopyUnicodeStringEx 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 la chaîne a été copiée 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 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.

RtlStringCbCopyUnicodeStringEx 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.
Un indicateur non valide est spécifié dans dwFlags.
La valeur dans cbDest est supérieure à la taille maximale de la mémoire tampon.
La mémoire tampon de destination (vers laquelle pointe pszDest ) est déjà pleine.
Un pointeur de mémoire tampon est NULL et l’indicateur STRSAFE_IGNORE_NULLS n’est pas spécifié.
Le pointeur de la mémoire tampon de destination est NULL, mais la taille de la mémoire tampon n’est pas égale à zéro.
Le pointeur de la 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.

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

Remarques

La fonction RtlStringCbCopyUnicodeStringEx utilise la taille de la mémoire tampon de destination (que le paramètre cbDest spécifie) pour s’assurer que l’opération de copie n’écrit pas au-delà de la fin de la mémoire tampon.

RtlStringCbCopyUnicodeStringEx ajoute aux fonctionnalités de la fonction RtlStringCbCopyUnicodeString en retournant un pointeur vers la fin de la chaîne de destination et le nombre d’octets inutilisés dans cette chaîne. Vous pouvez passer des indicateurs à la fonction 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 *SourceString *et pszDest 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 pszDest est NULL, le pointeur *SourceString *doit être NULL ou la structure UNICODE_STRING doit décrire 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

Partager via