StringCbCopyExW-Funktion (strsafe.h)
Kopiert eine 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.
StringCbCopyEx fügt der Funktionalität von StringCbCopy hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl der Bytes zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet werden. Flags können auch zur zusätzlichen Steuerung an die Funktion übergeben werden.
StringCbCopyEx ist ein Ersatz für die folgenden Funktionen:
Syntax
STRSAFEAPI StringCbCopyExW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_LPCWSTR pszSrc,
[out, optional] STRSAFE_LPWSTR *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 des Zielpuffers in Bytes. Dieser Wert muss die Länge von pszSrc plus das abschließende NULL-Zeichen berücksichtigen. Die maximal zulässige Anzahl von Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR)
.
[in] pszSrc
Typ: LPCTSTR
Die Quellzeichenfolge. Diese Zeichenfolge muss NULL-endend sein.
[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] pcbRemaining
Typ: size_t*
Die Anzahl nicht verwendeter 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:
Wert | Bedeutung |
---|---|
|
Wenn die Funktion erfolgreich ist, wird das niedrige Byte von dwFlags (0) verwendet, um den nicht initialisierten Teil von pszDest nach dem endenden NULL-Zeichen auszufüllen. |
|
Behandeln Sie NULL-Zeichenfolgenzeiger wie leere Zeichenfolgen (TEXT("")). Dieses Flag ist nützlich, um Funktionen wie lstrcpy zu emulieren. |
|
Wenn die Funktion fehlschlägt, wird das niedrige Byte von dwFlags (0) verwendet, um den gesamten pszDest-Puffer aufzufüllen, und der Puffer ist NULL-beendet. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede zurückgegebene abgeschnittene Zeichenfolge überschrieben. |
|
Wenn die Funktion fehlschlägt, wird pszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede abgeschnittene Zeichenfolge überschrieben. |
|
Wenn die Funktion fehlschlägt, wird wie bei STRSAFE_NULL_ON_FAILUREpszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede abgeschnittene Zeichenfolge überschrieben. |
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 ist pszDestNULL , wenn Quelldaten zum Kopieren vorhanden sind, oder ein ungültiges Flag wurde übergeben. |
|
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
Im Vergleich zu den ersetzten Funktionen bietet StringCbCopyEx 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. StringCbCopyEx beendet immer NULL und überläuft nie einen gültigen Zielpuffer, auch wenn sich der Inhalt der Quellzeichenfolge während des Vorgangs ändert.
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.
StringCbCopyEx 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.
String-Datentyp | Zeichenfolgenliterale | Funktion |
---|---|---|
char | „String“ | StringCbCopyExA |
TCHAR | TEXT("string") | StringCbCopyEx |
WCHAR | L"string" | StringCbCopyExW |
Hinweis
Der strsafe.h-Header definiert StringCbCopyEx 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
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