StringCchCopyW-Funktion (strsafe.h)

Artikel
03/02/2024

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

StringCchCopy ersetzt die folgenden Funktionen:

Syntax

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

Parameter

[out] pszDest

Typ: LPTSTR

Der Zielpuffer, der die kopierte Zeichenfolge empfängt.

[in] cchDest

Typ: size_t

Die Größe des Zielpuffers in Zeichen. Dieser Wert muss der Länge von pszSrc plus 1 entsprechen, um die kopierte Quellzeichenfolge und das beendende NULL-Zeichen zu berücksichtigen. Die maximal zulässige Anzahl von Zeichen ist STRSAFE_MAX_CCH.

[in] pszSrc

Typ: LPCTSTR

Die Quellzeichenfolge. Diese Zeichenfolge muss null beendet 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 wurden vorhanden, vollständig ohne Abschneiden kopiert, 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.
STRSAFE_E_INSUFFICIENT_BUFFER	Fehler beim Kopiervorgang aufgrund des unzureichenden Pufferspeichers. 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 StringCchCopy 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. StringCchCopy 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 StringCchCopyEx .

StringCchCopy 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“	StringCchCopyA
TCHAR	TEXT("string")	StringCchCopy
WCHAR	L"Zeichenfolge"	StringCchCopyW

Hinweis

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

StringCbCopy

StringCchCopyEx

Share via