RtlStringCbCatNA-Funktion (ntstrsafe.h)

Artikel
05/03/2024

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

Syntax

NTSTRSAFEDDI RtlStringCbCatNA(
  [in, out] NTSTRSAFE_PSTR pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
            size_t         cbToAppend
);

Parameter

[in, out] pszDest

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 cbToAppend Bytes 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 Puffer muss groß genug sein, um sowohl Zeichenfolgen als auch das abschließende NULL-Zeichen enthalten zu können.

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

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

cbToAppend

Die maximale Anzahl von Bytes, 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 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.

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 war vorhanden.
Die Länge des Zielpuffers war null, aber eine Quellzeichenfolge ungleich null war vorhanden.

Hinweise

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 hinaus schreiben.

Verwenden Sie RtlStringCbCatNW zum Verarbeiten von Unicode-Zeichenfolgen und RtlStringCbCatNA 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"	RtlStringCbCatNW
char	„String“	RtlStringCbCatNA

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 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

RtlStringCbCat

RtlStringCbCatNEx

RtlStringCchCatN

Freigeben über