Fonction RtlStringCbCopyA (ntstrsafe.h)

  • Article

Les fonctions RtlStringCbCopyW et RtlStringCbCopyA copient une chaîne comptée en octets dans une mémoire tampon.

Syntaxe

NTSTRSAFEDDI RtlStringCbCopyA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  NTSTRSAFE_PCSTR pszSrc
);

Paramètres

[out] pszDest

Pointeur vers une mémoire tampon fournie par l’appelant qui reçoit la chaîne copiée. La chaîne au niveau pszSrc est copiée dans la mémoire tampon à l’emplacement pszDest et se termine par un caractère null.

[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).

[in] pszSrc

Pointeur vers une chaîne terminée par null fournie par l’appelant.

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 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 tampon insuffisant. La mémoire tampon de destination contient une version tronquée et terminée par un caractère Null du résultat prévu.
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 :

  • 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.
  • La longueur de la mémoire tampon de destination était égale à zéro, mais une chaîne source de longueur différente de zéro était présente.

Remarques

RtlStringCbCopyA et RtlStringCbCopyW doivent être utilisés à la place des fonctions suivantes :

  • strcpy
  • wcscpy
RtlStringCbCopyA et RtlStringCbCopyW ne remplacent pas strncpy. Pour remplacer strncpy, utilisez RtlStringCbCopyN ou RtlStringCbCopyNEx.

La taille de la mémoire tampon de destination est fournie à la fonction pour garantir que RtlStringCbCopy n’écrit pas au-delà de la fin de la mémoire tampon.

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

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 être NULL. Si vous devez gérer les valeurs de pointeur de chaîne NULL , utilisez RtlStringCbCopyEx.

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 PASSIVE_LEVEL

Voir aussi

RtlStringCbCopyEx

RtlStringCchCopy