RtlStringCchCatNW-Funktion (ntstrsafe.h)

Die Funktionen RtlStringCchCatNW und RtlStringCchCatNA verketten zwei zeichenzählte Zeichenfolgen, während die Größe der angefügten Zeichenfolge begrenzt wird.

Syntax

NTSTRSAFEDDI RtlStringCchCatNW(
  [in, out] NTSTRSAFE_PWSTR pszDest,
  [in]      size_t          cchDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
            size_t          cchToAppend
);

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 bis zu cchMaxAppend-Zeichen wird am Ende der Zeichenfolge bei pszDest hinzugefügt und mit einem NULL-Zeichen beendet.

[in] cchDest

Die Größe des Zielpuffers in Zeichen. Die maximale Anzahl zulässiger Zeichen ist NTSTRSAFE_MAX_CCH.

[in] pszSrc

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

cchToAppend

Die maximale Anzahl von Zeichen, die an die Zeichenfolge angefügt werden sollen, 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.

Die Funktion gibt den STATUS_INVALID_PARAMETER-Wert zurück, wenn:

  • Der Wert in cchDest 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

RtlStringCchCatNW und RtlStringCchCatNA sollten anstelle der folgenden Funktionen verwendet werden:

  • strncat
  • wcsncat
Die Größe des Zielpuffers in Zeichen wird für die Funktion bereitgestellt, um sicherzustellen, dass RtlStringCchCatNW und RtlStringCchCatNA nicht über das Ende des Puffers hinaus schreiben.

Verwenden Sie RtlStringCchCatNW zum Verarbeiten von Unicode-Zeichenfolgen und RtlStringCchCatNA zum Verarbeiten von ANSI-Zeichenfolgen. Das verwendete Formular hängt von Ihren Daten ab, wie in der folgenden Tabelle gezeigt.

String-Datentyp Zeichenfolgenliteral Funktion
WCHAR L"string" RtlStringCchCatNW
Char „String“ RtlStringCchCatNA
 

Wenn pszSrc und pszDest auf überlappende Zeichenfolgen verweisen, ist das Verhalten der Funktion nicht definiert.

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

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 PASSIVE_LEVEL

Weitere Informationen

RtlStringCbCatN

RtlStringCchCat

RtlStringCchCatNEx