StringCbLengthW, fonction (strsafe.h)

Article
11/20/2024

Détermine si une chaîne dépasse la longueur spécifiée, en octets.

stringCbLength est un remplacement des fonctions suivantes :

strlen, wcslen, _tcslen

Syntaxe

STRSAFEAPI StringCbLengthW(
  [in]  STRSAFE_PCNZWCH psz,
  [in]  size_t          cbMax,
  [out] size_t          *pcbLength
);

Paramètres

[in] psz

Type : LPCTSTR

Chaîne dont la longueur doit être vérifiée.

[in] cbMax

Type : size_t

Nombre maximal d’octets autorisés dans psz, y compris ceux utilisés pour la fin du caractère Null. Cette valeur ne peut pas dépasser STRSAFE_MAX_CCH * sizeof(TCHAR).

[out] pcbLength

Type : size_t*

Nombre d’octets dans psz, à l’exclusion des octets utilisés pour le caractère null de fin. Cette valeur est valide uniquement si n’est pas NULL et que la fonction réussit.

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
S_OK	La chaîne à psz n’a pas été NULL et la longueur de la chaîne (y compris le caractère null de fin) est inférieure ou égale à caractères cbMax.
STRSAFE_E_INVALID_PARAMETER	La valeur dans psz est NULL , cbMax est supérieure à `STRSAFE_MAX_CCH * sizeof(TCHAR)`, ou psz est plus long que cbMax.

Notez que cette fonction retourne une valeur HRESULT, contrairement aux fonctions qu’elle remplace.

Remarques

Par rapport aux fonctions qu’il remplace, StringCbLength est un outil 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.

StringCbLength peut être utilisé dans sa forme générique ou dans ses formes plus spécifiques. Le type de données de la chaîne détermine la forme de cette fonction que vous devez utiliser.

Type de données de chaîne	Littéral de chaîne	Fonction
char	« string »	StringCbLengthA
TCHAR	TEXT(« string »)	StringCbLength
WCHAR	L"string »	StringCbLengthW

UnalignedStringCbLength est un alias pour cette fonction.

Note

L’en-tête strsafe.h définit StringCbLength 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

stringCchLength

Partager via