RtlStringCchCatNExW-Funktion (ntstrsafe.h)

Artikel
08/07/2023

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

Syntax

NTSTRSAFEDDI RtlStringCchCatNExW(
  [in, out, optional] NTSTRSAFE_PWSTR pszDest,
  [in]                size_t          cchDest,
  [in, optional]      STRSAFE_PCNZWCH pszSrc,
                      size_t          cchToAppend,
  [out, optional]     NTSTRSAFE_PWSTR *ppszDestEnd,
  [out, optional]     size_t          *pcchRemaining,
  [in]                DWORD           dwFlags
);

Parameter

[in, out, optional] 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. Der pszDest-Zeiger kann NULL sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlags festgelegt ist.

[in] cchDest

Die Größe des Zielpuffers in Zeichen. Die maximale Anzahl zulässiger Zeichen ist NTSTRSAFE_MAX_CCH. Wenn pszDestNULL ist, muss cchDest null sein.

[in, optional] pszSrc

Ein Zeiger auf eine NULL-endende Zeichenfolge. Diese Zeichenfolge wird am Ende der Zeichenfolge verkettet, die im Puffer bei pszDest enthalten ist. Der pszSrc-Zeiger kann NULL sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlags festgelegt ist.

cchToAppend

Die maximale Anzahl von Zeichen, die an die Zeichenfolge angefügt werden sollen, die im Puffer bei pszDest enthalten ist.

[out, optional] ppszDestEnd

Wenn der Aufrufer einen Adresszeiger ungleich NULL bereitstellt, lädt die Funktion nach Abschluss des Verkettungsvorgangs diese Adresse mit einem Zeiger auf den resultierenden NULL-Zeichenfolgenabschluss des Zielpuffers.

[out, optional] pcchRemaining

Wenn der Aufrufer einen Adresszeiger ungleich NULL bereitstellt, lädt die Funktion die Adresse mit der Anzahl nicht verwendeter Zeichen im Puffer, auf die pszDest verweist, einschließlich des abschließenden NULL-Zeichens.

[in] dwFlags

Mindestens ein Flag und optional ein Füllbyte. Die Flags werden wie folgt definiert:

Wert	Bedeutung
STRSAFE_FILL_BEHIND_NULL	Wenn dieses Flag festgelegt ist und die Funktion erfolgreich ist, wird das niedrige Byte von dwFlags verwendet, um den Teil des Zielpuffers zu füllen, der auf das abschließende NULL-Zeichen folgt.
STRSAFE_IGNORE_NULLS	Wenn dieses Flag festgelegt ist, kann entweder pszDest oder pszSrc oder beides NULL sein. NULLpszSrc-Zeiger werden wie leere Zeichenfolgen (TEXT("")) behandelt, die kopiert werden können. NULLpszDest-Zeiger können keine nicht leeren Zeichenfolgen empfangen.
STRSAFE_FILL_ON_FAILURE	Wenn dieses Flag festgelegt ist und die Funktion fehlschlägt, wird das niedrige Byte von dwFlags verwendet, um den gesamten Zielpuffer aufzufüllen, und der Puffer ist null-beendet. Dieser Vorgang überschreibt alle bereits vorhandenen Pufferinhalte.
STRSAFE_NULL_ON_FAILURE	Wenn dieses Flag festgelegt ist und die Funktion fehlschlägt, wird der Zielpuffer auf eine leere Zeichenfolge (TEXT("")) festgelegt. Dieser Vorgang überschreibt alle bereits vorhandenen Pufferinhalte.
STRSAFE_NO_TRUNCATION	Wenn dieses Flag festgelegt ist und die Funktion STATUS_BUFFER_OVERFLOW zurückgibt: Wenn auch STRSAFE_FILL_ON_FAILURE angegeben ist, füllt STRSAFE_NO_TRUNCATION den Zielpuffer entsprechend aus. Andernfalls wird der Zielpuffer unverändert.

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 Ausgabezeichenfolge ohne Abschneiden erstellt wurde und der resultierende Zielpuffer NULL-beendet ist.
STATUS_BUFFER_OVERFLOW	Diese Warnung status bedeutet, dass der Vorgang aufgrund unzureichenden Speicherplatzes im Zielpuffer nicht abgeschlossen wurde. Wenn STRSAFE_NO_TRUNCATION festgelegt ist, finden Sie weitere Informationen im dwFlags-Parameter .
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: Es wurde ein ungültiges Flag angegeben. Der Wert in cchDest ist größer als die maximale Puffergröße. Der Zielpuffer war bereits voll. Ein NULL-Zeiger war ohne das flag STRSAFE_IGNORE_NULLS vorhanden. Der Zielpufferzeiger war NULL, aber die Puffergröße war nicht 0(0). Der Zielpufferzeiger war NULL, oder seine Länge war null, aber eine Quellzeichenfolge ungleich null war vorhanden.

Rückgabecode

Beschreibung

STATUS_SUCCESS

Dieser Erfolg status bedeutet, dass Quelldaten vorhanden waren, die Ausgabezeichenfolge ohne Abschneiden erstellt wurde und der resultierende Zielpuffer NULL-beendet ist.

STATUS_BUFFER_OVERFLOW

Diese Warnung status bedeutet, dass der Vorgang aufgrund unzureichenden Speicherplatzes im Zielpuffer nicht abgeschlossen wurde. Wenn STRSAFE_NO_TRUNCATION festgelegt ist, finden Sie weitere Informationen im dwFlags-Parameter .

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:

Es wurde ein ungültiges Flag angegeben.
Der Wert in cchDest ist größer als die maximale Puffergröße.
Der Zielpuffer war bereits voll.
Ein NULL-Zeiger war ohne das flag STRSAFE_IGNORE_NULLS vorhanden.
Der Zielpufferzeiger war NULL, aber die Puffergröße war nicht 0(0).
Der Zielpufferzeiger war NULL, oder seine Länge war null, aber eine Quellzeichenfolge ungleich null war vorhanden.

Hinweise

RtlStringCchCatNExW und RtlStringCchCatNExA sollten anstelle der folgenden Funktionen verwendet werden:

strncat
wcsncat

Die Größe des Zielpuffers in Zeichen wird für RtlStringCchCatNExW und RtlStringCchCatNExA bereitgestellt, um sicherzustellen, dass die Funktionen nicht über das Ende des Puffers hinaus schreiben.

RtlStringCchCatNExW und RtlStringCchCatNExA fügen der Funktionalität von RtlStringCchCatN hinzu, indem sie einen Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl der Zeichen zurückgeben, die in dieser Zeichenfolge nicht verwendet werden. Flags können zur zusätzlichen Steuerung an die Funktion übergeben werden.

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

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

Weder pszSrc noch pszDest können NULL sein, es sei denn, das STRSAFE_IGNORE_NULLS-Flag ist festgelegt. In diesem Fall kann eines oder beide NULL sein. Wenn pszDestNULL ist, muss pszSrc entweder NULL sein oder auf eine leere Zeichenfolge zeigen.

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