StringCchCatNW-Funktion (strsafe.h)
Verkettet die angegebene Anzahl von Zeichen von einer 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.
StringCchCatN ist ein Ersatz für die folgenden Funktionen:
Syntax
STRSAFEAPI StringCchCatNW(
[in, out] STRSAFE_LPWSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZWCH pszSrc,
[in] size_t cchToAppend
);
Parameter
[in, out] pszDest
Typ: LPTSTR
Der Zielpuffer, der die Zeichenfolge enthält, die mit pszSrc verkettet werden soll, und empfängt die gesamte resultierende Zeichenfolge. Die Zeichenfolge bei pszSrc, bis zu cchMaxAppend-Zeichen , wird am Ende der Zeichenfolge bei pszDest hinzugefügt.
[in] cchDest
Typ: size_t
Die Größe des Zielpuffers in Zeichen. Dieser Wert muss der Länge von pszSrc und entweder der Länge von pszDest oder cchMaxAppend entsprechen (je nachdem, welcher Wert kleiner ist). Fügen Sie zu dieser Summe 1 hinzu, um das endende NULL-Zeichen zu berücksichtigen. Die maximal zulässige Anzahl von Zeichen ist STRSAFE_MAX_CCH.
[in] pszSrc
Typ: LPCTSTR
Die Quellzeichenfolge, die mit dem Ende von pszDest verkettet ist. Diese Zeichenfolge muss null beendet sein.
[in] cchToAppend
Typ: size_t
Die maximale Anzahl von Zeichen, 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 |
---|---|
|
Quelldaten waren vorhanden, die Zeichenfolgen wurden ohne Abschneiden verkettet, und der resultierende Zielpuffer ist NULL-beendet. |
|
Der Wert in cchDest ist entweder größer als STRSAFE_MAX_CCH, oder der Zielpuffer ist bereits voll. |
|
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 StringCchCatN zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist mit vielen Sicherheitsproblemen verbunden, die Pufferüberläufe umfassen. StringCchCatN 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 StringCchCatNEx .
StringCchCatN 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“ | StringCchCatNA |
TCHAR | TEXT("string") | StringCchCatN |
WCHAR | L"Zeichenfolge" | StringCchCatNW |
Hinweis
Der strsafe.h-Header definiert StringCchCatN 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