RtlUnicodeStringInit-Funktion (ntstrsafe.h)

Die RtlUnicodeStringInit Funktion initialisiert eine UNICODE_STRING Struktur.

Syntax

NTSTRSAFEDDI RtlUnicodeStringInit(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc
);

Parameter

[out] DestinationString

Ein Zeiger auf eine UNICODE_STRING Struktur, die initialisiert werden soll. Der pszSrc Zeiger wird in die UNICODE_STRING Struktur des DestinationString Parameters kopiert. Die maximale Anzahl von Zeichen in der Zeichenfolge, auf die pszSrc verweist, ist NTSTRSAFE_UNICODE_STRING_MAX_CCH.

[in, optional] pszSrc

Wahlfrei. Ein Zeiger auf eine null-beendete Zeichenfolgenkonstante. Dieser Zeichenfolgenzeiger wird in das Buffer Member der UNICODE_STRING Struktur kopiert, auf das der DestinationString-Parameter verweist. Dieser Zeichenfolgenzeiger kann NULL-werden.

Rückgabewert

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

Rückgabecode	Beschreibung
STATUS_SUCCESS	Dieser Erfolg Status bedeutet, dass Quelldaten vorhanden waren, die Zeichenfolge ohne Abkürzung kopiert wurde und der resultierende Zielpuffer null beendet ist.
STATUS_INVALID_PARAMETER	Dieser Fehler Status bedeutet, dass die Funktion einen ungültigen Eingabeparameter empfangen hat. Weitere Informationen finden Sie in der folgenden Liste.

 

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

• Die Länge der Zeichenfolge, auf die der pszSrc Parameter verweist, ist größer als NTSTRSAFE_UNICODE_STRING_MAX_CCH Zeichen.
• Der DestinationString Zeiger ist NULL-, aber der pszSrc Zeiger ist nicht NULL-.

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

Bemerkungen

Die funktion RtlUnicodeStringInit führt folgende Aktionen aus:

• Legt den Length Member der UNICODE_STRING-Struktur fest, auf die der pszSrc Parameter verweist, auf die Länge der Zeichenfolge in Bytes, auf die der pszSrc Parameter verweist.
• Legt den MaximumLength Member der UNICODE_STRING Struktur auf die Länge der Zeichenfolge in Bytes fest, die der pszSrc Parameter auf plus 2 Byte verweist.
• Legt den Buffer Member der UNICODE_STRING Struktur auf die Adresse fest, die der pszSrc Parameter angibt.

Der DestinationString- Zeiger sollte nicht NULL-sein. Wenn Sie NULL-DestinationString- Zeigerwerte angeben müssen, verwenden Sie die funktion RtlUnicodeStringInitEx.

Weitere Informationen zu den sicheren Zeichenfolgenfunktionen finden Sie unter Verwenden von Funktionen für sichere Zeichenfolgen.

Anforderungen

Anforderung	Wert
Unterstützter Client (Mindestversion)	Verfügbar ab Windows XP mit Service Pack 1 (SP1).
Zielplattform	Desktop
Kopfzeile	ntstrsafe.h (include Ntstrsafe.h)
Bibliothek	Ntstrsafe.lib
IRQL	Wenn Zeichenfolgen, die bearbeitet werden, immer im Arbeitsspeicher vorhanden sind, andernfalls PASSIVE_LEVEL

Siehe auch

RtlUnicodeStringInitEx-

UNICODE_STRING