StringCbCopyNExA-Funktion (strsafe.h)
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.
StringCbCopyNEx fügt der Funktionalität von StringCbCopyN hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl von Bytes zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet werden. Flags können auch an die Funktion für ein zusätzliches Steuerelement übergeben werden.
StringCbCopyNEx ist ein Ersatz für die folgenden Funktionen:
Syntax
STRSAFEAPI StringCbCopyNExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cbToCopy,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
Parameter
[out] pszDest
Typ: LPTSTR
Der Zielpuffer, der die kopierte Zeichenfolge empfängt.
[in] cbDest
Typ: size_t
Die Größe von pszDest in Bytes. Dieser Wert muss mindestens groß genug sein, um die kopierten Bytes (die Länge von pszSrc oder den Wert von cbSrc, je nachdem, welcher Wert kleiner ist) sowie das beendende NULL-Zeichen zu berücksichtigen. Die maximale Anzahl zulässiger Bytes 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.
[out, optional] ppszDestEnd
Typ: LPTSTR*
Die Adresse eines Zeigers auf das Ende von pszDest. Wenn ppszDestEnd nicht NULL ist und alle Daten in den Zielpuffer kopiert werden, zeigt dies auf das beendende NULL-Zeichen am Ende der Zeichenfolge.
[out, optional] pcbRemaining
Typ: size_t*
Die Anzahl der nicht verwendeten Bytes in pszDest, einschließlich der bytes, die für das beendende NULL-Zeichen verwendet werden. Wenn pcbRemainingNULL ist, wird die Anzahl nicht beibehalten oder zurückgegeben.
[in] dwFlags
Art: DWORD
Mindestens einer der folgenden Werte:
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 |
|---|---|
|
Quelldaten wurden vorhanden, vollständig ohne Abschneiden kopiert, und der resultierende Zielpuffer ist NULL-beendet. |
|
Entweder pszDest oder pszSrc ist größer als STRSAFE_MAX_CCH * sizeof(TCHAR), pszDest ist NULL , wenn Quelldaten zum Kopieren vorhanden sind oder ein ungültiges Flag übergeben wurde.
|
|
Fehler beim Kopiervorgang aufgrund des unzureichenden Pufferspeichers. Abhängig vom Wert von dwFlags kann der Zielpuffer eine abgeschnittene, null-beendete Version des beabsichtigten Ergebnisses enthalten. 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
StringCbCopyNEx 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. StringCbCopyNEx 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 StringCbCopyNEx – 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, es sei denn, das STRSAFE_IGNORE_NULLS-Flag ist angegeben. In diesem Fall können beide NULL sein. Ein Fehler aufgrund unzureichenden Speicherplatzes kann jedoch trotzdem zurückgegeben werden, obwohl NULL-Werte ignoriert werden.
StringCbCopyNEx kann in seiner 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 gezeigt.
| String-Datentyp | Zeichenfolgenliterale | Funktion |
|---|---|---|
| char | „String“ | StringCbCopyNExA |
| TCHAR | TEXT("string") | StringCbCopyNEx |
| WCHAR | L"Zeichenfolge" | StringCbCopyNExW |
Hinweis
Der strsafe.h-Header definiert StringCbCopyNEx 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