Partager via

Fonction RtlStringCbCopyNExW (ntstrsafe.h)

  • Article

Les fonctions RtlStringCbCopyNExW et RtlStringCbCopyNExA copient une chaîne comptée d’octets dans une mémoire tampon tout en limitant la taille de la chaîne copiée.

Syntaxe

NTSTRSAFEDDI RtlStringCbCopyNExW(
  [out, optional] NTSTRSAFE_PWSTR pszDest,
  [in]            size_t          cbDest,
  [in, optional]  STRSAFE_PCNZWCH pszSrc,
                  size_t          cbToCopy,
  [out, optional] NTSTRSAFE_PWSTR *ppszDestEnd,
  [out, optional] size_t          *pcbRemaining,
  [in]            DWORD           dwFlags
);

Paramètres

[out, optional] pszDest

Pointeur vers une mémoire tampon fournie par l’appelant qui reçoit la chaîne copiée. La chaîne à pszSrc est copiée dans la mémoire tampon à 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] 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.

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 est NULL, cbDest doit être égal à zéro.

[in, optional] pszSrc

Pointeur vers une chaîne terminée par null fournie par l’appelant. Le pointeur pszSrc peut être NULL, mais uniquement si STRSAFE_IGNORE_NULLS est défini dans dwFlags .

cbToCopy

Nombre maximal d’octets à copier de *pszSrc* vers *pszDest*.

[out, optional] ppszDestEnd

Si l’appelant fournit un pointeur d’adresse null nonNULL, une fois l’opération de copie terminée, la fonction charge cette adresse avec un pointeur vers le pointeur de la mémoire tampon de destination.

[out, optional] pcbRemaining

Si l’appelant fournit un pointeur d’adresse NULL nonNULL, 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 la fin du caractère null.

[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, 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 cet indicateur est défini 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 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éfinie. STRSAFE_FILL_BEHIND_NULL est ignoré.

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 a été copié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 de copie 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 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 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

RtlStringCbCopyNExW et RtlStringCbCopyNExA doivent être utilisés au lieu de strncpy. Toutefois, ces fonctions diffèrent dans le comportement. Si cbSrc est supérieur au nombre d’octets dans pszSrc, les fonctions RtlStringCbCopyNEx, contrairement à strncpy, ne remplissent pas pszDest avec des caractères null jusqu’à ce que octets aient été copiés.

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

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

Utilisez RtlStringCbCopyNExW pour gérer les chaînes Unicode et RtlStringCbCopyNExA 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 de chaîne Littéral de chaîne Fonction
WCHAR L"string » RtlStringCbCopyNExW
char « string » RtlStringCbCopyNExA

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