StringCchCopyNExA-Funktion (strsafe.h)
Kopiert die angegebene Anzahl von Zeichen 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.
StringCchCopyNEx der Funktionalität von StringCchCopyN- hinzugefügt, indem ein Zeiger an das Ende der Zielzeichenfolge sowie die Anzahl der Zeichen zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet wurden. Flags können auch an die Funktion übergeben werden, um zusätzliche Steuerelemente zu erhalten.
StringCchCopyNEx ist ein Ersatz für 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 pszDestin 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, 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-Terminator gelesen werden, je nachdem, was zuerst kommt.
[in] cchToCopy
Typ: size_t
Die maximale Anzahl von Zeichen, die von pszSrc in pszDestkopiert werden sollen.
[out, optional] ppszDestEnd
Typ: LPTSTR*
Die Adresse eines Zeigers bis zum Ende pszDest. Wenn ppszDestEnd- nichtNULL- ist und alle Daten in den Zielpuffer kopiert werden, verweist dies auf das endende NULL-Zeichen am Ende der Zeichenfolge.
[out, optional] pcchRemaining
Typ: size_t*
Die Anzahl der nicht verwendeten Zeichen in pszDest, einschließlich des endenden Nullzeichens. Wenn pcchRemainingNULL-ist, wird die Anzahl nicht beibehalten oder zurückgegeben.
[in] dwFlags
Typ: DWORD-
Mindestens einer der folgenden Werte.
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 wurden vorhanden, vollständig ohne Abschneiden kopiert, und der resultierende Zielpuffer wird null beendet. |
|
Entweder pszDest oder pszSrc größer als STRSAFE_MAX_CCHist, pszDest- ist NULL-, wenn Quelldaten zum Kopieren vorhanden sind oder ein ungültiges Flag übergeben wurde. |
|
Fehler beim Kopiervorgang aufgrund unzureichender Pufferspeicher. Abhängig vom Wert von dwFlagskann der Zielpuffer eine abgeschnittene, null-beendete Version des beabsichtigten Ergebnisses enthalten. 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
StringCchCopyNEx- 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. StringCchCopyNEx immer null-terminates 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 cchSrc- größer als die Anzahl von Zeichen in pszSrcist, StringCchCopyNEx- im Gegensatz zu strncpy- nicht weiterhin pszDest mit NULL-Zeichen, bis cchSrc Zeichen kopiert wurden.
Das Verhalten ist nicht definiert, wenn sich die Zeichenfolgen, auf die pszSrc und pszDest verweisen, überlappen.
Weder pszSrc noch pszDest- sollte NULL- sein, es sei denn, das STRSAFE_IGNORE_NULLS Flag ist angegeben, in diesem Fall kann beide NULLsein. Ein Fehler aufgrund unzureichender Leerzeichen kann jedoch weiterhin zurückgegeben werden, obwohl NULL- Werte ignoriert werden.
StringCchCopyNEx- kann in der generischen Form oder in spezifischeren Formularen 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" | StringCchCopyNExA- |
| TCHAR- | TEXT("Zeichenfolge") | StringCchCopyNEx- |
| WCHAR- | L"string" | StringCchCopyNExW- |
Anmerkung
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 |
|---|---|
| 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-