Freigeben über

RtlUnicodeStringCbCopyNEx-Funktion (ntstrsafe.h)

  • Artikel

Die RtlUnicodeStringCbCopyNEx-Funktion kopiert eine Zeichenfolge von einer UNICODE_STRING Struktur in eine andere, während die Größe der kopierten Zeichenfolge begrenzt wird.

Syntax

NTSTRSAFEDDI RtlUnicodeStringCbCopyNEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            PCUNICODE_STRING SourceString,
  [in]            size_t           cbToCopy,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

Parameter

[out] DestinationString

Optional. Ein Zeiger auf eine UNICODE_STRING-Struktur , die die kopierte Zeichenfolge empfängt. Die Zeichenfolge, auf die die UNICODE_STRING Struktur des SourceString-Parameters verweist, wird in den Puffer kopiert, auf den die UNICODE_STRING Struktur des DestinationString-Parameters verweist. Die maximale Anzahl von Bytes im Zeichenfolgenpuffer der DestinationString-Struktur ist NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). DestinationString kann NULL sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlags festgelegt ist.

[in] SourceString

Optional. Ein Zeiger auf eine UNICODE_STRING Struktur, die die zu kopierende Zeichenfolge enthält. Die maximale Anzahl von Bytes im Zeichenfolgenpuffer der Struktur ist NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). SourceString kann NULL sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlags festgelegt ist.

[in] cbToCopy

Die Anzahl der Bytes, die von der Quelle in das Ziel kopiert werden sollen.

[out, optional] RemainingString

Optional. Wenn der Aufrufer einen Nicht-NULL-Zeiger auf eine UNICODE_STRING Struktur bereitstellt, legt die Funktion den Buffer-Member dieser Struktur auf das Ende der verketteten Zeichenfolge fest, legt den Length-Member der Struktur auf 0 fest und legt das MaximumLength-Element der Struktur auf die Anzahl der Bytes fest, die im Zielpuffer verbleiben. RemainingString kann NULL sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlags festgelegt ist.

[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 letzten Zeichen in der Zeichenfolge folgt.
STRSAFE_IGNORE_NULLS Wenn dieses Flag festgelegt ist, kann der Quell- oder Zielzeiger oder beides NULL sein. RtlUnicodeStringCbCopyNEx behandelt NULL-Quellpufferzeiger wie leere Zeichenfolgen (TEXT("")), die kopiert werden können. NULL-Zielpufferzeiger 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. 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 Inhalt des Zielpuffers auf eine leere Zeichenfolge festgelegt, auch wenn STRSAFE_NULL_ON_FAILURE nicht festgelegt ist. STRSAFE_FILL_BEHIND_NULL wird ignoriert.
STRSAFE_ZERO_LENGTH_ON_FAILURE Wenn dieses Flag festgelegt ist und die Funktion STATUS_BUFFER_OVERFLOW zurückgibt, wird die Länge der Zielzeichenfolge auf null Bytes festgelegt.

Rückgabewert

RtlUnicodeStringCbCopyNEx gibt einen der folgenden NTSTATUS-Werte zurück.

Rückgabecode Beschreibung
STATUS_SUCCESS Dieser Erfolg status bedeutet, dass Quelldaten vorhanden waren und die Zeichenfolgen ohne Abschneiden verkettet wurden.
STATUS_BUFFER_OVERFLOW Diese Warnung status bedeutet, dass der Kopiervorgang aufgrund des unzureichenden Speicherplatzes im Zielpuffer nicht abgeschlossen wurde. Wenn STRSAFE_NO_TRUNCATION in dwFlags festgelegt ist, wird der Zielpuffer nicht geändert. Wenn das Flag nicht festgelegt ist, enthält der Zielpuffer eine abgeschnittene Version der kopierten Zeichenfolge.
STATUS_INVALID_PARAMETER Dieser Fehler status bedeutet, dass die Funktion einen ungültigen Eingabeparameter erhalten hat. Weitere Informationen finden Sie in der folgenden Liste.

RtlUnicodeStringCbCopyNEx gibt den STATUS_INVALID_PARAMETER Wert zurück, wenn einer der folgenden Aktionen auftritt:

  • Der Inhalt einer UNICODE_STRING-Struktur ist ungültig.
  • In dwFlags wird ein ungültiges Flag angegeben.
  • Der Zielpuffer ist bereits voll.
  • Ein Pufferzeiger ist NULL , und das STRSAFE_IGNORE_NULLS-Flag wird in dwFlags nicht angegeben.
  • Der Zielpufferzeiger ist NULL, aber die Puffergröße ist nicht 0.
  • Der Zielpufferzeiger ist NULL, oder seine Länge ist 0, aber eine Quellzeichenfolge ohne Zerolänge ist vorhanden.
  • Der Wert des cbToCopy-Parameters ist größer als NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Informationen zum Testen von NTSTATUS-Werten finden Sie unter Verwenden von NTSTATUS-Werten.

Hinweise

Die RtlUnicodeStringCbCopyNEx-Funktion verwendet die Größe des Zielpuffers, um sicherzustellen, dass der Kopiervorgang nicht über das Ende des Puffers schreibt. Standardmäßig beendet die Funktion die resultierende Zeichenfolge nicht mit einem NULL-Zeichenwert (also mit null). Als Option kann der Aufrufer das flag STRSAFE_FILL_BEHIND und einen Füllbytewert von null bis null-terminate einer resultierenden Zeichenfolge verwenden, die nicht den gesamten Zielpuffer belegt.

RtlUnicodeStringCbCopyNEx fügt der Funktionalität der Funktion RtlUnicodeStringCbCopyN hinzu, indem eine UNICODE_STRING-Struktur zurückgegeben wird, die das Ende der Zielzeichenfolge und die Anzahl der Bytes identifiziert, die in dieser Zeichenfolge nicht verwendet werden. Sie können Flags für zusätzliche Steuerelemente an RtlUnicodeStringCbCopyNEx übergeben.

Wenn sich die Quell- und Zielzeichenfolgen überschneiden, ist das Verhalten der Funktion undefiniert.

Der SourceString- und DestinationString-Zeiger kann nur NULL sein, wenn das STRSAFE_IGNORE_NULLS-Flag in dwFlags festgelegt ist. Wenn STRSAFE_IGNORE_NULLS festgelegt ist, kann einer oder beide dieser Zeiger NULL sein. Wenn der DestinationString-ZeigerNULL ist, muss der SourceString-ZeigerNULL sein, oder die UNICODE_STRING-Struktur muss eine leere Zeichenfolge enthalten.

Weitere Informationen zu den Sicheren Zeichenfolgenfunktionen finden Sie unter Verwenden sicherer Zeichenfolgenfunktionen.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Verfügbar ab Windows XP mit Service Pack 1 (SP1).
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