StringCbCopyNA-Funktion (strsafe.h)
Kopiert die angegebene Anzahl von Bytes aus einer Zeichenfolge in eine andere. Die Größe des Zielpuffers wird der Funktion bereitgestellt, um sicherzustellen, dass er nicht über das Ende dieses Puffers schreibt.
StringCbCopyN- ist ein Ersatz für die folgenden Funktionen:
Syntax
STRSAFEAPI StringCbCopyNA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH 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 pszDest-in Byte. 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) und auch das endende NULL-Zeichen zu berücksichtigen. Die maximale Anzahl zulässiger Zeichen ist STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszSrc
Typ: LPCTSTR-
Die Quellzeichenfolge. Diese Zeichenfolge muss null beendet werden.
[in] cbToCopy
Typ: size_t
Die maximale Anzahl von Bytes, 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 |
|---|---|
|
Quelldaten waren vorhanden, die Daten wurden aus pszSrc ohne Abkürzung kopiert, und der resultierende Zielpuffer wird null beendet. |
|
Der Wert in cbDest- ist entweder größer als STRSAFE_MAX_CCH * sizeof(TCHAR), oder der Zielpuffer ist bereits voll.
|
|
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
StringCbCopyN- 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. StringCbCopyN 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 cbSrc- größer ist als die Anzahl der Bytes in pszSrc, StringCbCopyN- im Gegensatz zu strncpy- nicht weiterhin pszDest mit NULL-Zeichen, bis cbSrc Bytes 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 StringCbCopyNEx-, wenn Sie die Behandlung von Null-Zeichenfolgenzeigerwerten benötigen.
StringCbCopyN- 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" | StringCbCopyNA- |
| TCHAR- | TEXT("Zeichenfolge") | StringCbCopyN- |
| WCHAR- | L"string" | StringCbCopyNW- |
Anmerkung
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 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-