StringCchCopyNExW-Funktion (strsafe.h)
Kopiert die angegebene Anzahl von Zeichen aus 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 von Zeichen zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet werden. Flags können auch zur zusätzlichen Steuerung an die Funktion übergeben werden.
StringCchCopyNEx ist ein Ersatz für die folgenden Funktionen:
Syntax
STRSAFEAPI StringCchCopyNExW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZWCH pszSrc,
[in] size_t cchToCopy,
[out, optional] STRSAFE_LPWSTR *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, welcher Wert kleiner ist) plus 1 enthalten, 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-Abschlusszeichen lesbar sein, je nachdem, was zuerst eintritt.
[in] cchToCopy
Typ: size_t
Die maximale Anzahl von Zeichen, die aus pszSrc nach pszDest kopiert werden sollen.
[out, optional] ppszDestEnd
Typ: LPTSTR*
Die Adresse eines Zeigers auf das Ende von pszDest. Wenn ppszDestEnd ungleich NULL ist und alle Daten in den Zielpuffer kopiert werden, zeigt dies auf das endende NULL-Zeichen am Ende der Zeichenfolge.
[out, optional] pcchRemaining
Typ: size_t*
Die Anzahl nicht verwendeter Zeichen in pszDest, einschließlich des abschließenden 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 unzureichenden Pufferspeicherplatzes. Abhängig vom Wert von dwFlags kann der Zielpuffer eine abgeschnittene version des beabsichtigten Ergebnisses enthalten. In Situationen, in denen das Abschneiden akzeptabel ist, 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 Pufferbehandlung in Ihrem Code. Eine schlechte Pufferbehandlung ist in viele Sicherheitsprobleme verwickelt, die Pufferüberläufe beinhalten. StringCchCopyNEx beendet immer NULL und überläuft nie einen gültigen Zielpuffer, auch wenn sich der Inhalt der Quellzeichenfolge während des Vorgangs ändert.
Obwohl diese Routine als Ersatz für strncpy gedacht ist, gibt es Unterschiede im Verhalten. Wenn cchSrc größer als die Anzahl von Zeichen in pszSrc ist, wird StringCchCopyNEx – im Gegensatz zu strncpy – nicht mehr 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 dürfen 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 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"string" | StringCchCopyNExW |
Hinweis
Der strsafe.h-Header definiert StringCchCopyNEx 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 |
|---|---|
| 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