StringCchCopyNA-Funktion (strsafe.h)

Artikel
11/20/2024

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

StringCchCopyN- ist ein Ersatz für die folgenden Funktionen:

strncpy, wcsncpy, _tcsncpy

Syntax

STRSAFEAPI StringCchCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH 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 pszDestin Zeichen. Dieser Wert muss groß genug sein, um die kopierten Zeichen (die Länge von pszSrc oder den Wert von cchSrc, je nachdem, was kleiner ist) plus 1, um das endende 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-Terminator gelesen werden, je nachdem, was zuerst kommt.

[in] cchToCopy

Typ: size_t

Die maximale Anzahl von Zeichen, die von pszSrc in pszDestkopiert werden sollen.

Rückgabewert

Typ: HRESULT-

Diese Funktion kann einen der folgenden Werte zurückgeben. Es wird dringend empfohlen, die SUCCEEDED und FAILED Makros zum Testen des Rückgabewerts dieser Funktion zu verwenden.

Rückgabecode	Beschreibung
S_OK	Quelldaten waren vorhanden, die Zeichen wurden aus pszSrc ohne Abschneiden 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 unzureichender Pufferspeicher. Der Zielpuffer enthält eine abgeschnittene, null-beendete Version des beabsichtigten Ergebnisses. In Situationen, in denen abgeschnitten werden kann, kann dies möglicherweise nicht unbedingt als Fehlerbedingung angesehen werden.

Beachten Sie, dass diese Funktion einen HRESULT- Wert zurückgibt, im Gegensatz zu den funktionen, die sie ersetzt.

Bemerkungen

StringCchCopyN- bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist in vielen Sicherheitsproblemen mit Pufferüberläufen verbunden. StringCchCopyN immer null beendet und überläuft niemals einen gültigen Zielpuffer, auch wenn sich der Inhalt der Quellzeichenfolge während des Vorgangs ändert.

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

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

Weder pszSrc noch pszDest sollte NULLsein. Weitere Informationen finden Sie unter StringCchCopyNEx-, wenn Sie die Behandlung von Null-Zeichenfolgenzeigerwerten erfordern.

StringCchCopyN- kann in der 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 dargestellt.

String-Datentyp	Zeichenfolgenliteral	Funktion
Zeichen-	"string"	StringCchCopyNA-
TCHAR-	TEXT("Zeichenfolge")	StringCchCopyN-
WCHAR-	L"string"	StringCchCopyNW-

Anmerkung

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
mindestens unterstützte Client-	Windows XP mit SP2 [Desktop-Apps \| UWP-Apps]
mindestens unterstützte Server-	Windows Server 2003 mit SP1 [Desktop-Apps \| UWP-Apps]
Zielplattform-	Fenster
Header-	strsafe.h

Siehe auch

Referenz-

StringCbCopyN-

StringCchCopy-

StringCchCopyNEx-

Freigeben über