StringCbLengthA-Funktion (strsafe.h)

Artikel
11/20/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 pszzulässig sind, einschließlich derjenigen, die für das endende Nullzeichen verwendet werden. Dieser Wert darf STRSAFE_MAX_CCH * sizeof(TCHAR)nicht überschreiten.

[out] pcbLength

Typ: size_t*

Die Anzahl der Bytes in psz, mit Ausnahme der für das endierende Nullzeichen verwendeten Bytes. Dieser Wert ist nur gültig, wenn 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 SUCCEEDED und FAILED Makros zum Testen des Rückgabewerts dieser Funktion zu verwenden.

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

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

Bemerkungen

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

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

String-Datentyp	Zeichenfolgenliteral	Funktion
Zeichen-	"string"	StringCbLengthA-
TCHAR-	TEXT("Zeichenfolge")	StringCbLength-
WCHAR-	L"string"	StringCbLengthW-

UnalignedStringCbLength ist ein Alias für diese Funktion.

Anmerkung

Der strsafe.h-Header definiert StringCbLength als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, 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
mindestens unterstützte Client-	Windows XP mit SP2 [Desktop-Apps \| UWP-Apps]
mindestens unterstützte Server-	Windows Server 2003 mit SP1 [Desktop-Apps \| UWP-Apps]
Zielplattform-	Fenster
Header-	strsafe.h

Siehe auch

StringCchLength-

Freigeben über