StringCbCatNW-Funktion (strsafe.h)

Artikel
03/06/2024

Verkettet die angegebene Anzahl von Bytes von einer Zeichenfolge mit einer anderen Zeichenfolge. Die Größe des Zielpuffers in Bytes wird der Funktion zur Verfügung gestellt, um sicherzustellen, dass sie nicht über das Ende dieses Puffers hinaus schreibt.

StringCbCatN ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCbCatNW(
  [in, out] STRSAFE_LPWSTR  pszDest,
  [in]      size_t          cbDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
  [in]      size_t          cbToAppend
);

Parameter

[in, out] pszDest

Typ: LPTSTR

Der Zielpuffer, der die Zeichenfolge enthält, die mit pszSrc verkettet werden soll, und empfängt die resultierende Zeichenfolge. Die Zeichenfolge bei pszSrc bis zu cbMaxAppend-Bytes 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 entweder die Länge von pszDest oder cbMaxAppend (je nachdem, was kleiner ist) plus das beendende NULL-Zeichen berücksichtigen. Die maximale Anzahl zulässiger Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Typ: LPCTSTR

Die Quellzeichenfolge, die mit dem Ende von pszDest verkettet werden soll. Diese Quellzeichenfolge muss null-beendet sein.

[in] cbToAppend

Typ: size_t

Die maximale Anzahl von Bytes, die an pszDest angefügt werden sollen.

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 ohne Abschneiden verkettet, und der resultierende Zielpuffer ist NULL-beendet.
STRSAFE_E_INVALID_PARAMETER	Der Wert in cbDest ist größer als der maximal zulässige Wert, oder der Zielpuffer ist bereits voll.
STRSAFE_E_INSUFFICIENT_BUFFER	Der Verkettungsvorgang ist aufgrund unzureichender Pufferspeicherung fehlgeschlagen. Der Zielpuffer enthält eine abgeschnittene, NULL-beendete Version des beabsichtigten Ergebnisses. In Situationen, in denen abgeschnitten werden kann, 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

Im Vergleich zu den ersetzten Funktionen bietet StringCbCatN zusätzliche Verarbeitung für die ordnungsgemäße Pufferbehandlung in Ihrem Code. Eine schlechte Pufferbehandlung ist mit vielen Sicherheitsproblemen verbunden, die Pufferüberläufe umfassen. StringCbCatN beendet immer NULL und überläuft nie 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 von pszSrc und pszDest verwiesen wird, überlappen.

Weder pszSrc noch pszDest sollte NULL sein. Wenn Sie die Behandlung von NULL-Zeichenfolgenzeigerwerten benötigen, finden Sie unter StringCbCatNEx .

StringCbCatN 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.

String-Datentyp	Zeichenfolgenliterale	Funktion
char	„String“	StringCbCatNA
TCHAR	TEXT("string")	StringCbCatN
WCHAR	L"Zeichenfolge"	StringCbCatNW

Hinweis

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

Referenz

StringCbCat

StringCbCatNEx

StringCchCatN