StringCbCatA-Funktion (strsafe.h)

Artikel
08/26/2023

Verkettet eine Zeichenfolge mit einer anderen Zeichenfolge. Die Größe des Zielpuffers wird für die Funktion bereitgestellt, um sicherzustellen, dass sie nicht über das Ende dieses Puffers schreibt.

StringCbCat ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCbCatA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_LPCSTR pszSrc
);

Parameter

[in, out] pszDest

Typ: LPTSTR

Die Zeichenfolge, mit der pszSrc verkettet werden soll, und die die gesamte resultierende Zeichenfolge empfängt. Die Zeichenfolge bei pszSrc wird am Ende der Zeichenfolge bei pszDest hinzugefügt.

[in] cbDest

Typ: size_t

Die Größe des Zielpuffers in Bytes. Dieser Wert muss die Länge von pszSrc plus die Länge von pszDest plus das abschließende NULL-Zeichen berücksichtigen. Die maximal zulässige Anzahl von Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Typ: LPCTSTR

Die Quellzeichenfolge, die am Ende von pszDest verkettet werden soll. Diese Zeichenfolge muss NULL-endend sein.

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	Quelldaten waren vorhanden, die Zeichenfolgen wurden vollständig ohne Abschneiden verkettet, und der resultierende Zielpuffer ist NULL-beendet.
STRSAFE_E_INVALID_PARAMETER	Der Wert in cbDest ist entweder kleiner `sizeof(TCHAR)` oder größer als der maximal zulässige Wert.
STRSAFE_E_INSUFFICIENT_BUFFER	Fehler beim Verkettungsvorgang aufgrund unzureichenden Pufferspeicherplatzes. Der Zielpuffer enthält eine abgeschnittene, mit NULL beendete Version des beabsichtigten Ergebnisses. In Situationen, in denen das Abschneiden akzeptabel ist, kann dies nicht unbedingt als Fehlerbedingung angesehen werden.

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

Hinweise

StringCbCat bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferbehandlung in Ihrem Code. Eine schlechte Pufferbehandlung ist in viele Sicherheitsprobleme verwickelt, die Pufferüberläufe beinhalten. Er beendet immer null und überläuft nie einen gültigen Zielpuffer, auch wenn sich der Inhalt der Quellzeichenfolge während des Vorgangs ändert.

StringCbCat kann in seiner generischen Form oder in seinen spezifischeren Formen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten, wie in der folgenden Tabelle gezeigt.

String-Datentyp	Zeichenfolgenliterale	Funktion
char	„String“	StringCbCatA
TCHAR	TEXT("string")	StringCbCat
WCHAR	L"string"	StringCbCatW

Das Verhalten ist nicht definiert, wenn sich die Zeichenfolgen, auf die von pszSrc und pszDest verwiesen wird, überlappen.

Weder pszSrc noch pszDest darf NULL sein. Weitere Informationen finden Sie unter StringCbCatEx , wenn Sie die Behandlung von NULL-Zeichenfolgenzeigerwerten benötigen.

Hinweis

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


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

Referenz

StringCbCatEx

StringCbCatN

StringCchCat