RtlStringCbCatExW-Funktion (ntstrsafe.h)

Die Funktionen RtlStringCbCatExW und RtlStringCbCatExA verketten zwei bytegezählte Zeichenfolgen.

Syntax

NTSTRSAFEDDI RtlStringCbCatExW(
  [in, out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]                size_t           cbDest,
  [in, optional]      NTSTRSAFE_PCWSTR pszSrc,
  [out, optional]     NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional]     size_t           *pcbRemaining,
  [in]                DWORD            dwFlags
);

Parameter

[in, out, optional] 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 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] cbDest

Die Größe des Zielpuffers in Bytes. Der Puffer muss groß genug sein, um sowohl Zeichenfolgen als auch das beendende NULL-Zeichen zu enthalten.

Für 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, optional] pszSrc

Ein Zeiger auf eine NULL-Zeichenfolge. Diese Zeichenfolge wird mit dem 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.

[out, optional] ppszDestEnd

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

[out, optional] pcbRemaining

Wenn der Aufrufer einen Nicht-NULL-Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl der nicht verwendeten Bytes, die sich im Puffer befinden, auf die von pszDest verwiesen wird, einschließlich Bytes, die für das beendende NULL-Zeichen verwendet werden.

[in] dwFlags

Ein oder mehrere Flags 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 dem beendenden 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 zu fü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 nicht geä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 Zeichenfolgen vollständig verkettet wurden, ohne abgeschnitten zu werden, und der resultierende Zielpuffer null-beendet ist.
STATUS_BUFFER_OVERFLOW Diese Warnung status bedeutet, dass der Kopiervorgang aufgrund des 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 erhalten hat. Weitere Informationen finden Sie im folgenden Absatz.

Die Funktion gibt den STATUS_INVALID_PARAMETER in folgenden Fällen zurück:

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

Hinweise

Anstelle der folgenden Funktionen sollten RtlStringCbCatExW und RtlStringCbCatExA verwendet werden.

  • strcat
  • wcscat

Da RtlStringCbCatExW und RtlStringCbCatExAdie Größe des Zielpuffers als Eingabe empfangen, schreiben sie nicht über das Ende des Puffers hinaus.

RtlStringCbCatEx fügt der Funktionalität von RtlStringCbCat hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge zurückgegeben wird, sowie die Anzahl der Bytes, die in dieser Zeichenfolge nicht verwendet werden. Flags können auch für ein zusätzliches Steuerelement an die Funktion übergeben werden.

Verwenden Sie RtlStringCbCatExW zum Behandeln von Unicode-Zeichenfolgen und RtlStringCbCatExA zum Behandeln von ANSI-Zeichenfolgen. Das zu verwendende Formular wird durch Ihre Daten bestimmt, wie in der folgenden Tabelle dargestellt.

String-Datentyp Zeichenfolgenliteral Funktion
WCHAR L"Zeichenfolge" RtlStringCbCatExW
char „String“ RtlStringCbCatExA

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

Weder pszSrc noch pszDest kann NULL sein, es sei denn, das STRSAFE_IGNORE_NULLS-Flag ist festgelegt. In diesem Fall kann entweder 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

Weitere Informationen