StringCbCopyNW-Funktion (strsafe.h)

  • Artikel

Kopiert die angegebene Anzahl von Bytes von einer 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.

StringCbCopyN ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCbCopyNW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
  [in]  size_t          cbToCopy
);

Parameter

[out] pszDest

Typ: LPTSTR

Der Zielpuffer, der die kopierten Zeichen empfängt.

[in] cbDest

Typ: size_t

Die Größe von pszDest in Bytes. Dieser Wert muss groß genug sein, um die kopierten Bytes (die Größe von pszSrc oder den Wert von cbSrc, je nachdem, was kleiner ist) enthalten und auch das beendende NULL-Zeichen zu berücksichtigen. Die maximal zulässige Anzahl von Zeichen ist STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Typ: LPCTSTR

Die Quellzeichenfolge. Diese Zeichenfolge muss null beendet sein.

[in] cbToCopy

Typ: size_t

Die maximale Anzahl von Bytes, die von pszSrc in 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 Daten wurden ohne Abschneiden aus pszSrc kopiert, und der resultierende Zielpuffer ist NULL-beendet.
STRSAFE_E_INVALID_PARAMETER
 Der Wert in cbDest ist entweder größer als STRSAFE_MAX_CCH * sizeof(TCHAR), oder der Zielpuffer ist bereits voll.
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

StringCbCopyN bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferbehandlung im Code. Eine schlechte Pufferbehandlung ist mit vielen Sicherheitsproblemen verbunden, die Pufferüberläufe umfassen. StringCbCopyN beendet immer NULL und überläuft nie einen gültigen Zielpuffer, auch wenn sich der Inhalt der Quellzeichenfolge während des Vorgangs ändert.

Während diese Routine als Ersatz für strncpy gedacht ist, gibt es Unterschiede im Verhalten. Wenn cbSrc größer als die Anzahl der Bytes in pszSrc ist, wird StringCbCopyN – im Gegensatz zu strncpy – nicht weiterhin pszDest mit NULL-Zeichen versehen, bis cbSrc-Bytes kopiert wurden.

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, lesen Sie StringCbCopyNEx .

StringCbCopyN 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“ StringCbCopyNA
TCHAR TEXT("string") StringCbCopyN
WCHAR L"Zeichenfolge" StringCbCopyNW
 

Hinweis

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

   
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

StringCbCopyNEx

StringCchCopyN