RtlStringCchCatNA-Funktion (ntstrsafe.h)

Artikel
05/03/2024

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

Syntax

NTSTRSAFEDDI RtlStringCchCatNA(
  [in, out] NTSTRSAFE_PSTR pszDest,
  [in]      size_t         cchDest,
  [in]      STRSAFE_PCNZCH pszSrc,
            size_t         cchToAppend
);

Parameter

[in, out] pszDest

Ein Zeiger auf einen Puffer, der bei der Eingabe eine 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 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 maximal zulässige Anzahl von Zeichen ist NTSTRSAFE_MAX_CCH.

[in] pszSrc

Ein Zeiger auf eine NULL-Zeichenfolge. Diese Zeichenfolge wird mit dem 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 des unzureichenden Pufferspeichers 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 erhalten 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 0, aber eine Quellzeichenfolge mit ungleicher Länge 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 des unzureichenden Pufferspeichers 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 erhalten 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 0, aber eine Quellzeichenfolge mit ungleicher Länge 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 schreiben.

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

String-Datentyp	Zeichenfolgenliteral	Funktion
WCHAR	L"Zeichenfolge"	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	Alle, wenn Zeichenfolgen, die bearbeitet werden, immer im Arbeitsspeicher gespeichert sind, andernfalls PASSIVE_LEVEL

Weitere Informationen

RtlStringCbCatN

RtlStringCchCat

RtlStringCchCatNEx

Freigeben über