StringCchCopyNExA-Funktion (strsafe.h)
Kopiert die angegebene Anzahl von Zeichen 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.
StringCchCopyNEx fügt der Funktionalität von StringCchCopyN hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl der in dieser Zeichenfolge nicht verwendeten Zeichen zurückgegeben wird. Flags können auch an die Funktion für ein zusätzliches Steuerelement übergeben werden.
StringCchCopyNEx ersetzt die folgenden Funktionen:
Syntax
STRSAFEAPI StringCchCopyNExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cchToCopy,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
Parameter
[out] pszDest
Typ: LPTSTR
Der Zielpuffer, der die kopierte Zeichenfolge empfängt.
[in] cchDest
Typ: size_t
Die Größe von pszDest in Zeichen. Dieser Wert muss mindestens groß genug sein, um die kopierten Zeichen (die Länge von pszSrc oder den Wert von cchSrc, je nachdem, was kleiner ist) plus 1 enthalten, um das endende NULL-Zeichen zu berücksichtigen. Die maximal zulässige Anzahl von Zeichen ist STRSAFE_MAX_CCH.
[in] pszSrc
Typ: LPCTSTR
Die Quellzeichenfolge. Diese Zeichenfolge muss bis zu cchSrc-Zeichen oder null-Abschlusszeichen lesbar sein, je nachdem, was zuerst kommt.
[in] cchToCopy
Typ: size_t
Die maximale Anzahl von Zeichen, die von pszSrc nach 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] pcchRemaining
Typ: size_t*
Die Anzahl der nicht verwendeten Zeichen in pszDest, einschließlich des beendenden NULL-Zeichens. Wenn pcchRemainingNULL 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, 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
StringCchCopyNEx bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist mit vielen Sicherheitsproblemen verbunden, die Pufferüberläufe umfassen. StringCchCopyNEx 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 cchSrc größer als die Anzahl der Zeichen in pszSrc ist, wird StringCchCopyNEx – im Gegensatz zu strncpy – nicht weiterhin pszDest 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 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.
StringCchCopyNEx 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“ | StringCchCopyNExA |
| TCHAR | TEXT("string") | StringCchCopyNEx |
| WCHAR | L"Zeichenfolge" | StringCchCopyNExW |
Hinweis
Der strsafe.h-Header definiert StringCchCopyNEx als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für