RtlStringCchCatExA-Funktion (ntstrsafe.h)

  • Artikel

Die funktionen RtlStringCchCatExW und RtlStringCchCatExA verketten zwei zeichengezählte Zeichenfolgen.

Syntax

NTSTRSAFEDDI RtlStringCchCatExA(
  [in, out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]                size_t          cchDest,
  [in]                NTSTRSAFE_PCSTR pszSrc,
  [out, optional]     NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional]     size_t          *pcchRemaining,
  [in]                DWORD           dwFlags
);

Parameter

[in, out, optional] pszDest

Ein 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 wird am Ende der Zeichenfolge bei pszDest hinzugefügt und mit einem Nullzeichen beendet. Der pszDest Zeiger kann NULL-sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlagsfestgelegt ist.

[in] cchDest

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

[in] pszSrc

Ein Zeiger auf eine mit Null beendete Zeichenfolge. Diese Zeichenfolge wird an das Ende der Zeichenfolge verkettet, die im Puffer bei pszDestenthalten ist. Der pszSrc Zeiger kann NULL-sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlagsfestgelegt ist.

[out, optional] ppszDestEnd

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

[out, optional] pcchRemaining

Wenn der Aufrufer einen null-NULL- Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl nicht verwendeter Zeichen, die im Puffer enthalten sind, auf pszDestverweist, einschließlich des endenden NULL-Zeichens.

[in] dwFlags

Mindestens ein Flag und optional ein Füllbyte. Die Kennzeichen sind wie folgt definiert:

Wert Bedeutung
STRSAFE_FILL_BEHIND_NULL Wenn festgelegt und die Funktion erfolgreich ausgeführt wird, wird das niedrige Byte von dwFlags verwendet, um den Teil des Zielpuffers zu füllen, der dem endenden Nullzeichen folgt.
STRSAFE_IGNORE_NULLS Wenn festgelegt, kann entweder pszDest oder pszSrcoder beides nullsein. NULLpszSrc Zeiger werden wie leere Zeichenfolgen (TEXT("")) behandelt, die kopiert werden können. NULL-pszDest Zeiger können keine Zeichenfolgen empfangen.
STRSAFE_FILL_ON_FAILURE Wenn festgelegt und die Funktion fehlschlägt, wird das niedrige Byte von dwFlags verwendet, um den gesamten Zielpuffer auszufüllen, und der Puffer wird null-beendet. Mit diesem Vorgang werden alle bereits vorhandenen Pufferinhalte überschrieben.
STRSAFE_NULL_ON_FAILURE Wenn festgelegt und die Funktion fehlschlägt, wird der Zielpuffer auf eine leere Zeichenfolge (TEXT("")) festgelegt. Mit diesem Vorgang werden alle bereits vorhandenen Pufferinhalte überschrieben.
STRSAFE_NO_TRUNCATION

Wenn festgelegt und die Funktion STATUS_BUFFER_OVERFLOW zurückgibt:

  • Wenn STRSAFE_FILL_ON_FAILURE auch angegeben wird, 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 Ausgabezeichenfolge ohne Abkürzung erstellt wurde und der resultierende Zielpuffer null-beendet ist.
STATUS_BUFFER_OVERFLOW Diese Warnung Status bedeutet, dass der Vorgang 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 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 Kennzeichen angegeben.
  • Der Wert in cchDest- ist größer als die maximale Puffergröße.
  • Der Zielpuffer war bereits voll.
  • Ein NULL- Zeiger wurde ohne das STRSAFE_IGNORE_NULLS Flag vorhanden.
  • Der Zielpufferzeiger wurde NULL-, aber die Puffergröße war nicht null.
  • Der Zielpufferzeiger war NULL-, oder die Länge war null, aber eine nichtzero lange Quellzeichenfolge war vorhanden.

Bemerkungen

RtlStringCchCatExW und RtlStringCchCatExA- sollten anstelle der folgenden Funktionen verwendet werden:

  • strcat-
  • wcscat

Die Größe des Zielpuffers in Zeichen wird bereitgestellt, um sicherzustellen, dass RtlStringCchCatExW- und RtlStringCchCatExA- nicht über das Ende des Puffers schreiben.

RtlStringCchCatExW und RtlStringCchCatExA der Funktionalität von RtlStringCchCat durch Zurückgeben eines Zeigers an das Ende der Zielzeichenfolge sowie die Anzahl der im Zielpuffer nicht verwendeten Zeichen hinzufügen. Flags können für zusätzliche Steuerelemente an die Funktion übergeben werden.

Verwenden Sie RtlStringCchCatExW- zum Behandeln von Unicode-Zeichenfolgen und RtlStringCchCatExA- zum Behandeln von ANSI-Zeichenfolgen. Das von Ihnen verwendete Formular hängt von Ihren Daten ab.

Zeichenfolgendatentyp Zeichenfolgenliteral Funktion
WCHAR- L"string" RtlStringCchCatExW-
Zeichen- "string" RtlStringCchCatExA-

Wenn pszSrc und pszDest auf überlappende Zeichenfolgen zeigen, 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 beides NULL-sein. Wenn pszDest-NULL-ist, muss pszSrc entweder NULL- sein oder auf eine leere Zeichenfolge zeigen.

Weitere Informationen zu den funktionen für sichere Zeichenfolgen finden Sie unter Verwenden sicherer Zeichenfolgenfunktionen.

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