StringCchCopyNW-Funktion (strsafe.h)

  • Artikel

Kopiert die angegebene Anzahl von Zeichen aus einer Zeichenfolge in eine andere. Die Größe des Zielpuffers wird für die Funktion bereitgestellt, um sicherzustellen, dass StringCchCopyN nicht über das Ende dieses Puffers schreibt.

StringCchCopyN ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCchCopyNW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
  [in]  size_t          cchToCopy
);

Parameter

[out] pszDest

Typ: LPTSTR

Der Zielpuffer, der die kopierten Zeichen empfängt.

[in] cchDest

Typ: size_t

Die Größe von pszDest in Zeichen. Dieser Wert muss groß genug sein, um die kopierten Zeichen (die Länge von pszSrc oder den Wert von cchSrc, je nachdem, welcher Wert kleiner ist) plus 1 enthalten, um das abschließende NULL-Zeichen zu berücksichtigen. Die maximale Anzahl zulässiger Zeichen ist STRSAFE_MAX_CCH.

[in] pszSrc

Typ: LPCTSTR

Die Quellzeichenfolge. Diese Zeichenfolge muss bis zu cchSrc-Zeichen oder einem NULL-Abschlusszeichen lesbar sein, je nachdem, was zuerst eintritt.

[in] cchToCopy

Typ: size_t

Die maximale Anzahl von Zeichen, die aus pszSrc nach pszDest kopiert 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 Zeichen wurden ohne Abschneiden aus pszSrc kopiert, und der resultierende Zielpuffer ist NULL-beendet.
STRSAFE_E_INVALID_PARAMETER
 Der Wert in cchDest ist entweder größer als STRSAFE_MAX_CCH, oder der Zielpuffer ist bereits voll.
STRSAFE_E_INSUFFICIENT_BUFFER
 Fehler beim Kopiervorgang aufgrund unzureichenden Pufferspeicherplatzes. Der Zielpuffer enthält eine abgeschnittene, mit NULL beendete Version des beabsichtigten Ergebnisses. 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

StringCchCopyN 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. StringCchCopyN beendet immer NULL und überläuft nie einen gültigen Zielpuffer, auch wenn sich der Inhalt der Quellzeichenfolge während des Vorgangs ändert.

Obwohl diese Routine als Ersatz für strncpy gedacht ist, gibt es Unterschiede im Verhalten. Wenn cchSrc größer als die Anzahl von Zeichen in pszSrc ist, wird StringCchCopyN – im Gegensatz zu strncpy – nicht weiter mit NULL-Zeichen versehen , bis cchSrc-Zeichen kopiert wurden.

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

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

StringCchCopyN 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, wie in der folgenden Tabelle gezeigt.

String-Datentyp Zeichenfolgenliterale Funktion
char „String“ StringCchCopyNA
TCHAR TEXT("string") StringCchCopyN
WCHAR L"string" StringCchCopyNW
 

Hinweis

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

StringCbCopyN

StringCchCopy

StringCchCopyNEx