StringCbCatExA-Funktion (strsafe.h)
Verkettet eine 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.
StringCbCatEx der Funktionalität von StringCbCat- hinzugefügt, indem ein Zeiger an das Ende der Zielzeichenfolge sowie die Anzahl der bytes 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.
StringCbCatEx ist ein Ersatz für die folgenden Funktionen:
Syntax
STRSAFEAPI StringCbCatExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_LPCSTR pszSrc,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
Parameter
[in, out] pszDest
Typ: LPTSTR-
Die Zeichenfolge, mit der pszSrc verkettet werden soll und die die gesamte resultierende Zeichenfolge empfängt. Die Zeichenfolge bei pszSrc wird am Ende der Zeichenfolge bei pszDesthinzugefügt.
[in] cbDest
Typ: size_t
Die Größe des Zielpuffers in Byte. Dieser Wert muss die Länge pszSrc- plus die Länge pszDest plus das endende Nullzeichen berücksichtigen. Die maximale Anzahl zulässiger Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszSrc
Typ: LPCTSTR-
Die Quellzeichenfolge, die am Ende pszDest-verkettet ist. Diese Zeichenfolge muss null beendet werden.
[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] pcbRemaining
Typ: size_t*
Die Anzahl der nicht verwendeten Bytes in pszDest, einschließlich derjenigen, die für das endende Nullzeichen verwendet werden. Wenn pcbRemainingNULList, wird die Anzahl nicht beibehalten oder zurückgegeben.
[in] dwFlags
Typ: 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 pszDest nach dem endenden NULL-Zeichen auszufüllen. |
|
Behandeln Sie NULL- Zeichenfolgenzeiger wie leere Zeichenfolgen (TEXT("")). Dieses Kennzeichen ist nützlich, um Funktionen wie lstrcpyzu emulieren. |
|
Wenn die Funktion fehlschlägt, wird das niedrige Byte von dwFlags (0) verwendet, um den gesamten pszDest Puffer auszufüllen, und der Puffer wird null beendet. Bei einem STRSAFE_E_INSUFFICIENT_BUFFER Fehler wird jede bereits vorhandene oder abgeschnittene Zeichenfolge im Zielpuffer überschrieben. |
|
Wenn die Funktion fehlschlägt, wird pszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Bei einem STRSAFE_E_INSUFFICIENT_BUFFER Fehler wird jede bereits vorhandene oder abgeschnittene Zeichenfolge im Zielpuffer überschrieben. |
|
Wenn die Funktion fehlschlägt, bleibt pszDest unberührt. Dem ursprünglichen Inhalt wird nichts hinzugefügt. |
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 vollständig ohne Abschneiden verkettet, und der resultierende Zielpuffer ist null-beendet. |
|
Der Wert in cbDest- ist entweder kleiner als sizeof(TCHAR) oder größer als der maximal zulässige Wert.
|
|
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
StringCbCatEx- 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. StringCbCatEx immer null-terminates 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.
StringCbCatEx- 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" | StringCbCatExA- |
| TCHAR- | TEXT("Zeichenfolge") | StringCbCatEx- |
| WCHAR- | L"string" | StringCbCatExW- |
Anmerkung
Der strsafe.h-Header definiert StringCbCatEx 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-