Freigeben über


RtlStringCbCatNW-Funktion (ntstrsafe.h)

Die funktionen RtlStringCbCatNW und RtlStringCbCatNA verketten zwei Bytezählungszeichenfolgen, während die Größe der angefügten Zeichenfolge begrenzt wird.

Syntax

NTSTRSAFEDDI RtlStringCbCatNW(
  [in, out] NTSTRSAFE_PWSTR pszDest,
  [in]      size_t          cbDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
            size_t          cbToAppend
);

Parameter

[in, out] pszDest

Zeiger auf einen Puffer, der bei eingaben eine mit Null beendete 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 cbMaxAppend Bytes, wird am Ende der Zeichenfolge bei pszDest hinzugefügt und mit einem NULL-Zeichen beendet.

[in] cbDest

Die Größe des Zielpuffers in Byte. Der Puffer muss groß genug sein, um sowohl Zeichenfolgen als auch das endende Nullzeichen einzuschließen.

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

Bei ANSI-Zeichenfolgen ist die maximale Anzahl von Bytes NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

Zeiger auf eine mit Null beendete Zeichenfolge. Diese Zeichenfolge wird an das Ende der Zeichenfolge verkettet, die im Puffer bei pszDestenthalten ist.

cbToAppend

Die maximale Anzahl von Bytes, die an die Zeichenfolge angefügt werden soll, die im Puffer bei pszDestenthalten 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 Abkürzung verkettet wurden und der resultierende Zielpuffer null-beendet ist.
STATUS_BUFFER_OVERFLOW
Diese Warnung Status bedeutet, dass der Verkettungsvorgang aufgrund unzureichender Pufferspeicher nicht abgeschlossen wurde. Der Zielpuffer enthält eine abgeschnittene, 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 cbDest- ist größer als die maximale Puffergröße.
  • Der Zielpuffer war bereits voll.
  • Ein NULL- Zeiger vorhanden war.
  • Die Länge des Zielpuffers war null, aber eine Zeichenfolge mit nicht nuller Länge war vorhanden.

Bemerkungen

RtlStringCbCatNW und RtlStringCbCatNA- sollten anstelle der folgenden Funktionen verwendet werden:

  • strncat
  • wcsncat
Die Größe des Zielpuffers in Bytes wird für RtlStringCbCatNW und RtlStringCbCatNA- bereitgestellt, um sicherzustellen, dass sie nicht über das Ende des Puffers schreiben.

Verwenden Sie RtlStringCbCatNW- zum Behandeln von Unicode-Zeichenfolgen und RtlStringCbCatNA- zum Behandeln von ANSI-Zeichenfolgen. Das formular, das Sie verwenden, hängt von Ihren Daten ab, wie in der folgenden Tabelle dargestellt.

Zeichenfolgendatentyp Zeichenfolgenliteral Funktion
WCHAR L"string" RtlStringCbCatNW-
Zeichen- "string" RtlStringCbCatNA-
 

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

Weder pszSrc noch pszDest kann NULLsein. Wenn Sie NULL- Zeichenfolgenzeigerwerte behandeln müssen, verwenden Sie RtlStringCbCatNEx-.

Weitere Informationen zu den sicheren Zeichenfolgenfunktionen finden Sie unter Verwenden von Funktionen für sichere Zeichenfolgen.

Anforderungen

Anforderung Wert
mindestens unterstützte Client- Verfügbar in Windows XP mit Service Pack 1 (SP1) und höheren Versionen von Windows.
Zielplattform- Desktop
Header- ntstrsafe.h (include Ntstrsafe.h)
Library Ntstrsafe.lib
IRQL- Wenn Zeichenfolgen, die bearbeitet werden, immer im Arbeitsspeicher vorhanden sind, andernfalls PASSIVE_LEVEL

Siehe auch

RtlStringCbCat-

RtlStringCbCatNEx-

RtlStringCchCatN-