StringCchCatNExA-Funktion (strsafe.h)
Verkettet die angegebene Anzahl von Zeichen aus einer Zeichenfolge mit einer anderen Zeichenfolge. Die Größe des Zielpuffers wird der Funktion bereitgestellt, um sicherzustellen, dass er nicht über das Ende dieses Puffers schreibt.
StringCchCatNEx der Funktionalität von StringCchCatN- hinzu, 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.
StringCchCatNEx- ist ein Ersatz für die folgenden Funktionen:
Syntax
STRSAFEAPI StringCchCatNExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cchToAppend,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
Parameter
[in, out] pszDest
Typ: LPTSTR-
Der Zielpuffer, der die Zeichenfolge enthält, die mit pszSrc-verkettet werden soll, und erhält die gesamte resultierende Zeichenfolge. Die Zeichenfolge bei pszSrc wird am Ende der Zeichenfolge bei pszDesthinzugefügt.
[in] cchDest
Typ: size_t
Die Größe des Zielpuffers in Zeichen. Dieser Wert muss der Länge von pszSrc plus der Länge pszDest plus 1 entsprechen, um das endende Nullzeichen zu berücksichtigen. Die maximale Anzahl zulässiger Zeichen ist STRSAFE_MAX_CCH.
[in] pszSrc
Typ: LPCTSTR-
Die Quellzeichenfolge, die am Ende pszDest-verkettet ist. Diese Zeichenfolge muss null beendet werden.
[in] cchToAppend
Typ: size_t
Die maximale Anzahl von Zeichen, die an pszDest-angefügt werden sollen.
[out, optional] ppszDestEnd
Typ: LPTSTR*
Die Adresse eines Zeigers bis zum Ende pszDest. Wenn ppszDestEnd nichtNULL- ist und alle Daten an den Zielpuffer angefügt 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 waren vorhanden, die Zeichenfolgen wurden ohne Abschneiden verkettet, und der resultierende Zielpuffer ist null-beendet. |
|
Der Wert in cchDest- ist größer als STRSAFE_MAX_CCH, ein ungültiges Flag wurde übergeben, oder es gibt Abweichungen zwischen der Größe der pszDest, cchDestund der Menge an Material, das in pszSrcangefügt werden soll. |
|
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
Im Vergleich zu den ersetzten Funktionen bietet StringCchCatNEx- zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist in vielen Sicherheitsproblemen mit Pufferüberläufen verbunden. StringCchCatNEx immer null beendet und überläuft niemals 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 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.
StringCchCatNEx- kann in der generischen Form oder in spezifischeren Formen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten.
| String-Datentyp | Zeichenfolgenliteral | Funktion |
|---|---|---|
| Zeichen- | "string" | StringCchCatNExA- |
| TCHAR- | TEXT("Zeichenfolge") | StringCchCatNEx- |
| WCHAR- | L"string" | StringCchCatNExW- |
Anmerkung
Der strsafe.h-Header definiert StringCchCatNEx 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-