StringCbLengthA-Funktion (strsafe.h)

Artikel
03/02/2024

Bestimmt, ob eine Zeichenfolge die angegebene Länge in Bytes überschreitet.

StringCbLength ist ein Ersatz für die folgenden Funktionen:

strlen, wcslen, _tcslen

Syntax

STRSAFEAPI StringCbLengthA(
  [in]  STRSAFE_PCNZCH psz,
  [in]  size_t         cbMax,
  [out] size_t         *pcbLength
);

Parameter

[in] psz

Typ: LPCTSTR

Die Zeichenfolge, deren Länge überprüft werden soll.

[in] cbMax

Typ: size_t

Die maximale Anzahl von Bytes, die in psz zulässig sind, einschließlich der Bytes, die für das beendende NULL-Zeichen verwendet werden. Dieser Wert darf nicht überschreiten STRSAFE_MAX_CCH * sizeof(TCHAR).

[out] pcbLength

Typ: size_t*

Die Anzahl der Bytes in psz, mit Ausnahme der Bytes, die für das beendende NULL-Zeichen verwendet werden. Dieser Wert ist nur gültig, wenn die Pcb nicht NULL ist und die Funktion erfolgreich ist.

Rückgabewert

Typ: HRESULT

Diese Funktion kann einen der folgenden Werte zurückgeben. Es wird dringend empfohlen, die Makros SUCCEEDED und FAILED zu verwenden, um den Rückgabewert dieser Funktion zu testen.

Rückgabecode	BESCHREIBUNG
S_OK	Die Zeichenfolge bei psz war nicht NULL, und die Länge der Zeichenfolge (einschließlich des beendenden NULL-Zeichens) ist kleiner oder gleich cbMax-Zeichen .
STRSAFE_E_INVALID_PARAMETER	Der Wert in psz ist NULL, cbMax ist größer als `STRSAFE_MAX_CCH * sizeof(TCHAR)`, oder psz ist länger als cbMax.

Beachten Sie, dass diese Funktion im Gegensatz zu den funktionen, die sie ersetzt, einen HRESULT-Wert zurückgibt.

Hinweise

Im Vergleich zu den ersetzten Funktionen ist StringCbLength ein zusätzliches Tool für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist mit vielen Sicherheitsproblemen verbunden, die Pufferüberläufe umfassen.

StringCbLength kann in seiner generischen Form oder in spezifischeren Formen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten.

String-Datentyp	Zeichenfolgenliterale	Funktion
char	„String“	StringCbLengthA
TCHAR	TEXT("string")	StringCbLength
WCHAR	L"Zeichenfolge"	StringCbLengthW

UnalignedStringCbLength ist ein Alias für diese Funktion.

Hinweis

Der strsafe.h-Header definiert StringCbLength als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP mit SP2 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 mit SP1 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	strsafe.h

Weitere Informationen

StringCchLength

Freigeben über