RtlUnicodeStringCchCopyNEx-Funktion (ntstrsafe.h)

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

Syntax

NTSTRSAFEDDI RtlUnicodeStringCchCopyNEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            PCUNICODE_STRING SourceString,
  [in]            size_t           cchToCopy,
  [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 Zeichen im Zeichenfolgenpuffer der Struktur ist NTSTRSAFE_UNICODE_STRING_MAX_CCH. 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 Zeichen 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] cchToCopy

Die Anzahl der Zeichen, die aus 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:

Rückgabewert

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

RtlUnicodeStringCchCopyNEx 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 cchToCopy-Parameters ist größer als NTSTRSAFE_UNICODE_STRING_MAX_CCH.

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

Hinweise

Die RtlUnicodeStringCchCopyNEx-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.

RtlUnicodeStringCchCopyNEx fügt die Funktionalität der RtlUnicodeStringCchCopyN-Funktion 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 RtlUnicodeStringCchCopyNEx ü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

Weitere Informationen

• RtlUnicodeStringCbCopyNEx
• RtlUnicodeStringCchCopyN
• UNICODE_STRING