RtlStringCbCatW-Funktion (ntstrsafe.h)

Artikel
05/03/2024

Die Funktionen RtlStringCbCatW und RtlStringCbCatA verketten zwei bytegezählte Zeichenfolgen.

Syntax

NTSTRSAFEDDI RtlStringCbCatW(
  [in, out] NTSTRSAFE_PWSTR  pszDest,
  [in]      size_t           cbDest,
  [in]      NTSTRSAFE_PCWSTR pszSrc
);

Parameter

[in, out] pszDest

Ein Zeiger auf einen Puffer, der bei der Eingabe eine NULL-endende Zeichenfolge enthält, mit der pszSrc verkettet wird. Bei der Ausgabe ist dies der Zielpuffer, der die gesamte resultierende Zeichenfolge enthält. Die Zeichenfolge bei pszSrc wird am Ende der Zeichenfolge bei pszDest hinzugefügt und mit einem NULL-Zeichen beendet.

[in] cbDest

Die Größe des Zielpuffers in Bytes. Der Zielpuffer muss groß genug sein, um die verketteten Zeichenfolgen und das endende NULL-Zeichen einzuschließen.

Bei Unicode-Zeichenfolgen beträgt die maximale Anzahl von Bytes NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Für ANSI-Zeichenfolgen beträgt die maximale Anzahl von Bytes NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

Ein Zeiger auf eine NULL-endende Zeichenfolge. Diese Zeichenfolge wird am Ende der Zeichenfolge verkettet, die im Puffer bei pszDest enthalten ist.

Rückgabewert

Die Funktion gibt einen der NTSTATUS-Werte zurück, die in der folgenden Tabelle aufgeführt sind. Informationen zum Testen von NTSTATUS-Werten finden Sie unter Verwenden von NTSTATUS-Werten.

Rückgabecode	Beschreibung
STATUS_SUCCESS	Dieser Erfolg status bedeutet, dass Quelldaten vorhanden waren, die Zeichenfolgen ohne Abschneiden verkettet wurden und der resultierende Zielpuffer NULL-beendet ist.
STATUS_BUFFER_OVERFLOW	Diese Warnung status bedeutet, dass der Verkettungsvorgang aufgrund eines unzureichenden Pufferspeichers nicht abgeschlossen wurde. Der Zielpuffer enthält eine abgeschnittene, mit NULL beendete Version des beabsichtigten Ergebnisses.
STATUS_INVALID_PARAMETER	Dieser Fehler status bedeutet, dass die Funktion einen ungültigen Eingabeparameter empfangen hat. Weitere Informationen finden Sie im folgenden Absatz. Der STATUS_INVALID_PARAMETER Rückgabewert bedeutet, dass einer der folgenden Ereignisse aufgetreten ist: Der Wert in cbDest ist größer als die maximale Puffergröße. Der Zielpuffer war bereits voll. Ein NULL-Zeiger war vorhanden. Die Länge des Zielpuffers war null, aber eine Quellzeichenfolge ungleich null war vorhanden.

Rückgabecode

Beschreibung

STATUS_SUCCESS

Dieser Erfolg status bedeutet, dass Quelldaten vorhanden waren, die Zeichenfolgen ohne Abschneiden verkettet wurden und der resultierende Zielpuffer NULL-beendet ist.

STATUS_BUFFER_OVERFLOW

Diese Warnung status bedeutet, dass der Verkettungsvorgang aufgrund eines unzureichenden Pufferspeichers nicht abgeschlossen wurde. Der Zielpuffer enthält eine abgeschnittene, mit NULL beendete Version des beabsichtigten Ergebnisses.

STATUS_INVALID_PARAMETER

Dieser Fehler status bedeutet, dass die Funktion einen ungültigen Eingabeparameter empfangen hat. Weitere Informationen finden Sie im folgenden Absatz.

Der STATUS_INVALID_PARAMETER Rückgabewert bedeutet, dass einer der folgenden Ereignisse aufgetreten ist:

Der Wert in cbDest ist größer als die maximale Puffergröße.
Der Zielpuffer war bereits voll.
Ein NULL-Zeiger war vorhanden.
Die Länge des Zielpuffers war null, aber eine Quellzeichenfolge ungleich null war vorhanden.

Hinweise

RtlStringCbCatW und RtlStringCbCatA sollten anstelle der folgenden Funktionen verwendet werden:

strcat
wcscat

Da RtlStringCbCatW und RtlStringCbCatA die Größe des Zielpuffers als Eingabe empfangen, schreiben sie nicht über das Ende des Puffers hinaus.

Verwenden Sie RtlStringCbCatW zum Behandeln von Unicode-Zeichenfolgen und RtlStringCbCatA zum Verarbeiten von ANSI-Zeichenfolgen. Das zu verwendende Formular wird durch Ihre Daten bestimmt, wie in der folgenden Tabelle dargestellt.

String-Datentyp	Zeichenfolgenliteral	Funktion
WCHAR	L"string"	RtlStringCbCatW
char	„String“	RtlStringCbCatA

Wenn pszSrc und pszDest auf Zeichenfolgen verweisen, die sich überlappen, ist das Verhalten der Funktionen nicht definiert.

Weder pszSrc noch pszDest können NULL sein. Wenn Sie NULL-Zeichenfolgenzeigerwerte verarbeiten müssen, verwenden Sie RtlStringCbCatNEx.

Weitere Informationen zu den sicheren Zeichenfolgenfunktionen finden Sie unter Verwenden sicherer Zeichenfolgenfunktionen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Verfügbar in Windows XP mit Service Pack 1 (SP1) und höheren Versionen von Windows.
Zielplattform	Desktop
Kopfzeile	ntstrsafe.h (einschließen von Ntstrsafe.h)
Bibliothek	Ntstrsafe.lib
IRQL	Alle, wenn Zeichenfolgen, die bearbeitet werden, immer im Arbeitsspeicher gespeichert sind, andernfalls PASSIVE_LEVEL

Weitere Informationen

RtlStringCbCatEx

RtlStringCbCatNEx

RtlStringCchCatEx

Freigeben über