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

StringCchCatEx fügt der Funktionalität von StringCchCat hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl von Zeichen zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet werden. Flags können auch zur zusätzlichen Steuerung an die Funktion übergeben werden.

StringCchCatEx ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCchCatExW(
  [in, out]       STRSAFE_LPWSTR  pszDest,
  [in]            size_t          cchDest,
  [in]            STRSAFE_LPCWSTR pszSrc,
  [out, optional] STRSAFE_LPWSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags
);

Parameter

[in, out] pszDest

Typ: LPTSTR

Der Zielpuffer, der die Zeichenfolge enthält, die mit pszSrc verkettet werden soll und die gesamte resultierende Zeichenfolge empfängt. Die Zeichenfolge bei pszSrc 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 plus der Länge von pszDest plus 1 entsprechen, um sowohl Zeichenfolgen als auch das abschließende NULL-Zeichen zu berücksichtigen. Die maximale Anzahl zulässiger Zeichen ist STRSAFE_MAX_CCH.

[in] pszSrc

Typ: LPCTSTR

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

[out, optional] ppszDestEnd

Typ: LPTSTR*

Die Adresse eines Zeigers auf das Ende von pszDest. Wenn ppszDestEnd ungleich NULL ist und alle Daten an den Zielpuffer angefügt werden, verweist dies auf das endende NULL-Zeichen am Ende der Zeichenfolge.

[out, optional] pcchRemaining

Typ: size_t*

Die Anzahl nicht verwendeter Zeichen in pszDest, einschließlich des abschließenden NULL-Zeichens. Wenn pcchRemainingNULL ist, wird die Anzahl nicht beibehalten oder zurückgegeben.

[in] dwFlags

Art: DWORD

Mindestens einer der folgenden Werte:

Wert	Bedeutung
STRSAFE_FILL_BEHIND_NULL 0x00000200	Wenn die Funktion erfolgreich ist, wird das niedrige Byte von dwFlags (0) verwendet, um den nicht initialisierten Teil von pszDest nach dem endenden NULL-Zeichen auszufüllen.
STRSAFE_IGNORE_NULLS 0x00000100	Behandeln Sie NULL-Zeichenfolgenzeiger wie leere Zeichenfolgen (TEXT("")). Dieses Flag ist nützlich, um Funktionen wie lstrcpy zu emulieren.
STRSAFE_FILL_ON_FAILURE 0x00000400	Wenn die Funktion fehlschlägt, wird das niedrige Byte von dwFlags (0) verwendet, um den gesamten pszDest-Puffer aufzufüllen, und der Puffer ist NULL-beendet. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede bereits vorhandene oder abgeschnittene Zeichenfolge im Zielpuffer überschrieben.
STRSAFE_NULL_ON_FAILURE 0x00000800	Wenn die Funktion fehlschlägt, wird pszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede bereits vorhandene oder abgeschnittene Zeichenfolge im Zielpuffer überschrieben.
STRSAFE_NO_TRUNCATION 0x00001000	Wenn die Funktion fehlschlägt, ist pszDest unberührt. Dem ursprünglichen Inhalt wird nichts hinzugefügt.

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 cchDest ist entweder 0 oder größer als STRSAFE_MAX_CCH, oder der Zielpuffer ist bereits voll.
STRSAFE_E_INSUFFICIENT_BUFFER	Fehler beim Kopiervorgang aufgrund unzureichenden Pufferspeicherplatzes. Abhängig vom Wert von dwFlags kann der Zielpuffer eine abgeschnittene version des beabsichtigten Ergebnisses enthalten. 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

StringCchCatEx 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. StringCchCatEx 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 dürfen NULL sein, es sei denn, das STRSAFE_IGNORE_NULLS Flag ist angegeben. In diesem Fall können beide NULL sein. Ein Fehler aufgrund unzureichenden Speicherplatzes kann jedoch trotzdem zurückgegeben werden, obwohl NULL-Werte ignoriert werden.

StringCchCatEx kann in seiner 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 gezeigt.

String-Datentyp	Zeichenfolgenliterale	Funktion
char	„String“	StringCchCatExA
TCHAR	TEXT("string")	StringCchCatEx
WCHAR	L"string"	StringCchCatExW

Hinweis

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

Referenz

StringCbCatEx

StringCchCat

StringCchCatNEx

Share via