StringCchLengthA-Funktion (strsafe.h)

Artikel
03/04/2024

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

StringCchLength ist ein Ersatz für die folgenden Funktionen:

strlen, wcslen, _tcslen

Syntax

STRSAFEAPI StringCchLengthA(
  [in]  STRSAFE_PCNZCH psz,
  [in]  size_t         cchMax,
  [out] size_t         *pcchLength
);

Parameter

[in] psz

Typ: LPCTSTR

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

[in] cchMax

Typ: size_t

Die maximale Anzahl von Zeichen, die in psz zulässig sind, einschließlich des abschließenden NULL-Zeichens. Dieser Wert darf STRSAFE_MAX_CCH nicht überschreiten.

[out] pcchLength

Typ: size_t*

Die Anzahl der Zeichen in psz, ohne das abschließende NULL-Zeichen. Dieser Wert ist nur gültig, wenn pcch 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 abschließenden NULL-Zeichens) ist kleiner oder gleich cchMax-Zeichen .
STRSAFE_E_INVALID_PARAMETER	Der Wert in psz ist NULL, cchMax ist größer als STRSAFE_MAX_CCH oder psz ist länger als cchMax.

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 StringCchLength ein zusätzliches Tool für die ordnungsgemäße Pufferbehandlung in Ihrem Code. Eine schlechte Pufferbehandlung ist in viele Sicherheitsprobleme verwickelt, die Pufferüberläufe beinhalten.

StringCchLength 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“	StringCchLengthA
TCHAR	TEXT("string")	StringCchLength
WCHAR	L"string"	StringCchLengthW

UnalignedStringCchLength ist ein Alias für diese Funktion.

Hinweis

Der strsafe.h-Header definiert StringCchLength 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
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

StringCbLength

Freigeben über