StringCchCatW-Funktion (strsafe.h)

Artikel
11/20/2024

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

StringCchCat- ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCchCatW(
  [in, out] STRSAFE_LPWSTR  pszDest,
  [in]      size_t          cchDest,
  [in]      STRSAFE_LPCWSTR pszSrc
);

Parameter

[in, out] pszDest

Typ: LPTSTR-

Der Zielpuffer, der die Zeichenfolge enthält, mit der pszSrc verkettet werden soll und die die gesamte resultierende Zeichenfolge empfängt. Die Zeichenfolge bei pszSrc wird am Ende der Zeichenfolge bei pszDesthinzugefügt.

[in] cchDest

Typ: size_t

Die Größe des Zielpuffers in Zeichen. Dieser Wert muss größer oder gleich der Länge von pszSrc plus der Länge pszDest plus 1 sein, um sowohl Zeichenfolgen als auch das endende Nullzeichen zu berücksichtigen. Die maximale Anzahl zulässiger Zeichen ist STRSAFE_MAX_CCH.

[in] pszSrc

Typ: LPCTSTR-

Die Quellzeichenfolge, die am Ende pszDest-verkettet werden soll. Diese Zeichenfolge muss null beendet werden.

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	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 cchDest- ist entweder 0 oder größer als STRSAFE_MAX_CCH, oder der Zielpuffer ist bereits voll.
STRSAFE_E_INSUFFICIENT_BUFFER	Fehler beim Verkettungsvorgang aufgrund unzureichender Pufferspeicher. Der Zielpuffer enthält eine abgeschnittene, null-beendete Version des beabsichtigten Ergebnisses. In Situationen, in denen abgeschnitten werden kann, kann dies möglicherweise nicht unbedingt als Fehlerbedingung angesehen werden.

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

Bemerkungen

StringCchCat- bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist in vielen Sicherheitsproblemen mit Pufferüberläufen verbunden. StringCchCat immer null beendet und überläuft niemals einen gültigen Zielpuffer, auch wenn sich der Inhalt der Quellzeichenfolge während des Vorgangs ändert.

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

Weder pszSrc noch pszDest sollte NULLsein. Weitere Informationen finden Sie unter StringCchCatEx-, wenn Sie die Behandlung von Null-Zeichenfolgenzeigerwerten benötigen.

StringCchCat- kann in der generischen Form oder in spezifischeren Formen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten, wie in der folgenden Tabelle dargestellt.

String-Datentyp	Zeichenfolgenliteral	Funktion
Zeichen-	"string"	StringCchCatA-
TCHAR-	TEXT("Zeichenfolge")	StringCchCat-
WCHAR-	L"string"	StringCchCatW-

Anmerkung

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

Referenz-

StringCbCat-

StringCchCatEx-

StringCchCatN-

Freigeben über