Fonction StringCbLengthA (strsafe.h)

Article
03/02/2024

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

StringCbLength remplace les fonctions suivantes :

strlen, wcslen, _tcslen

Syntaxe

STRSAFEAPI StringCbLengthA(
  [in]  STRSAFE_PCNZCH 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 le caractère null de fin. Cette valeur ne peut pas dépasser STRSAFE_MAX_CCH * sizeof(TCHAR).

[out] pcbLength

Type : size_t*

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

Valeur retournée

Type : HRESULT

Cette fonction peut retourner l’une des valeurs suivantes. Il est vivement recommandé d’utiliser les macros SUCCEEDED et FAILED pour tester la valeur de retour de cette fonction.

Code de retour	Description
S_OK	La chaîne au niveau psz n’était pas NULL et la longueur de la chaîne (y compris le caractère null de fin) est inférieure ou égale à des caractères cbMax .
STRSAFE_E_INVALID_PARAMETER	La valeur dans psz est NULL, cbMax est supérieur à `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 une gestion appropriée de la mémoire tampon dans votre code. Une gestion médiocre de la mémoire tampon est impliquée dans de nombreux problèmes de sécurité qui impliquent des dépassements de mémoire tampon.

StringCbLength peut être utilisé sous 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.

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

UnalignedStringCbLength est un alias pour cette fonction.

Notes

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

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP avec SP2 [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2003 avec SP1 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	strsafe.h

Voir aussi

StringCchLength

Partager via