StringCbCopyNExA, fonction (strsafe.h)
Copie le nombre spécifié d’octets d’une chaîne vers une autre. La taille de la mémoire tampon de destination est fournie à la fonction pour s’assurer qu’elle n’écrit pas au-delà de la fin de cette mémoire tampon.
StringCbCopyNEx ajoute aux fonctionnalités de StringCbCopyN 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.
StringCbCopyNEx remplace les fonctions suivantes :
Syntaxe
STRSAFEAPI StringCbCopyNExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cbToCopy,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
Paramètres
[out] pszDest
Type : LPTSTR
Mémoire tampon de destination, qui reçoit la chaîne copiée.
[in] cbDest
Type : size_t
Taille de pszDest, en octets. Cette valeur doit être au moins grande pour contenir les octets copiés (la longueur de pszSrc ou la valeur de cbSrc, le cas échéant plus petit), ainsi que pour tenir compte du caractère null de fin. Le nombre maximal d’octets autorisés est STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszSrc
Type : LPCTSTR
Chaîne source. Cette chaîne doit être terminée par null.
[in] cbToCopy
Type : size_t
Nombre maximal d’octets à copier de pszSrc à pszDest.
[out, optional] ppszDestEnd
Type : LPTSTR*
Adresse d’un pointeur à la fin de pszDest. Si ppszDestEnd n’est pas NULL et que toutes les données sont copiées dans la mémoire tampon de destination, cela pointe vers le caractère null de fin à la fin de la chaîne.
[out, optional] pcbRemaining
Type : size_t*
Nombre d’octets inutilisés dans pszDest, y compris ceux utilisés pour la fin du caractère null. Si de personnalisation est NULL, le nombre n’est pas conservé ou retourné.
[in] dwFlags
Type : DWORD
Une ou plusieurs des valeurs suivantes.
Valeur de retour
Type : HRESULT
Cette fonction peut retourner l’une des valeurs suivantes. Il est fortement recommandé d’utiliser les macros SUCCEEDED et FAILED pour tester la valeur de retour de cette fonction.
| Retourner le code | Description |
|---|---|
|
Les données sources étaient présentes, entièrement copiées sans troncation, et la mémoire tampon de destination résultante est terminée par null. |
|
pszDest ou pszSrc est supérieur à STRSAFE_MAX_CCH * sizeof(TCHAR), pszDest est NULL lorsqu’il existe des données sources présentes pour la copie ou qu’un indicateur non valide a été passé.
|
|
L’opération de copie a échoué en raison d’un espace tampon insuffisant. Selon la valeur de dwFlags, la mémoire tampon de destination peut contenir une version tronquée et terminée par null du résultat prévu. Dans les situations où la troncation est acceptable, cela peut ne pas nécessairement être considéré comme une condition d’échec. |
Notez que cette fonction retourne une valeur HRESULT, contrairement aux fonctions qu’elle remplace.
Remarques
StringCbCopyNEx fournit un traitement supplémentaire pour la gestion appropriée des mémoires tampons dans votre code. Une mauvaise gestion des mémoires tampons est impliquée dans de nombreux problèmes de sécurité qui impliquent des dépassements de mémoire tampon. StringCbCopyNEx se termine toujours par null et ne dépasse jamais une mémoire tampon de destination valide, même si le contenu de la chaîne source change pendant l’opération.
Bien que cette routine soit destinée à remplacer strncpy, il existe des différences de comportement. Si cbSrc est supérieur au nombre d’octets dans pszSrc, StringCbCopyNEx( contrairement à strncpy) ne continue pas à remplir pszDest avec des caractères null jusqu’à ce que octets cbSrc aient été copiés.
Le comportement n’est pas défini si les chaînes pointées par pszSrc et pszDest chevauchent.
Ni pszSrc ni pszDest ne doit être NULL, sauf si l’indicateur STRSAFE_IGNORE_NULLS est spécifié, auquel cas les deux peuvent être NULL. Toutefois, une erreur due à un espace insuffisant peut toujours être retournée même si valeurs NULL sont ignorées.
StringCbCopyNEx peut être utilisé dans sa forme générique ou dans ses formulaires plus spécifiques. Le type de données de la chaîne détermine la forme de cette fonction que vous devez utiliser, comme indiqué dans le tableau suivant.
| Type de données de chaîne | Littéral de chaîne | Fonction |
|---|---|---|
| char | « string » | StringCbCopyNExA |
| TCHAR | TEXT(« string ») | StringCbCopyNEx |
| WCHAR | L"string » | StringCbCopyNExW |
Note
L’en-tête strsafe.h définit StringCbCopyNEx comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Windows XP avec SP2 [applications de bureau | Applications UWP] |
| serveur minimum pris en charge | Windows Server 2003 avec SP1 [applications de bureau | Applications UWP] |
| plateforme cible | Windows |
| d’en-tête | strsafe.h |
Voir aussi
de référence