StringCbCatNExA-Funktion (strsafe.h)
Verkettet die angegebene Anzahl von Bytes von einer Zeichenfolge mit einer anderen Zeichenfolge. Die Größe des Zielpuffers wird für die Funktion bereitgestellt, um sicherzustellen, dass sie nicht über das Ende dieses Puffers schreibt.
StringCbCatNEx ist ein Ersatz für die folgenden Funktionen:
StringCbCatNEx fügt der Funktionalität von StringCbCatN hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl der bytes, die in dieser Zeichenfolge nicht verwendet werden, zurückgegeben wird. Flags können auch an die Funktion für ein zusätzliches Steuerelement übergeben werden.Syntax
STRSAFEAPI StringCbCatNExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cbToAppend,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
Parameter
[in, out] pszDest
Typ: LPTSTR
Der Zielpuffer, der die Zeichenfolge enthält, die mit pszSrc verkettet werden soll, und empfängt die gesamte resultierende Zeichenfolge. Die Zeichenfolge bei pszSrc wird am Ende der Zeichenfolge bei pszDest hinzugefügt.
[in] cbDest
Typ: size_t
Die Größe des Zielpuffers in Bytes. Dieser Wert muss die Länge von pszSrc plus die Länge von pszDest plus die Bytes berücksichtigen, die für das beendende NULL-Zeichen verwendet werden. Die maximale Anzahl zulässiger Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszSrc
Typ: LPCTSTR
Die Quellzeichenfolge, die mit dem Ende von pszDest verkettet werden soll. Diese Zeichenfolge muss null beendet sein.
[in] cbToAppend
Typ: size_t
Die maximale Anzahl von Bytes, die an pszDest angefügt werden sollen.
[out, optional] ppszDestEnd
Typ: LPTSTR*
Die Adresse eines Zeigers auf das Ende von pszDest. Wenn ppszDestEnd nicht NULL ist und alle Daten an den Zielpuffer angefügt 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 waren vorhanden, die Zeichenfolgen wurden ohne Abschneiden verkettet, und der resultierende Zielpuffer ist NULL-beendet. |
|
Der Wert in cbDest ist größer als STRSAFE_MAX_CCH * sizeof(TCHAR), ein ungültiges Flag wurde übergeben, oder es gibt Abweichungen zwischen der Größe von pszDest, cbDest und der Menge an Material, die in pszSrc angefügt werden soll.
|
|
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
Im Vergleich zu den ersetzten Funktionen bietet StringCbCatNEx 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. StringCbCatNEx 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 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.
StringCbCatNEx 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“ | StringCbCatNExA |
| TCHAR | TEXT("string") | StringCbCatNEx |
| WCHAR | L"Zeichenfolge" | StringCbCatNExW |
Hinweis
Der strsafe.h-Header definiert StringCbCatNEx 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