RtlStringCchCopyNW-Funktion (ntstrsafe.h)

Die Funktionen RtlStringCchCopyNW und RtlStringCchCopyNA kopieren eine zeichengezählte Zeichenfolge in einen Puffer, während die Größe der kopierten Zeichenfolge begrenzt wird.

Syntax

NTSTRSAFEDDI RtlStringCchCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cchToCopy
);

Parameter

[out] pszDest

Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der die kopierte Zeichenfolge empfängt. Die Zeichenfolge bei pszSrc bis zu cchSrc-Zeichen wird bei pszDest in den Puffer kopiert und mit einem NULL-Zeichen beendet.

[in] cchDest

Die Größe des Zielpuffers in Zeichen. Die maximal zulässige Anzahl von Zeichen ist NTSTRSAFE_MAX_CCH.

[in] pszSrc

Ein Zeiger auf eine vom Aufrufer bereitgestellte, NULL-beendete Zeichenfolge.

cchToCopy

Die maximale Anzahl von Zeichen, die aus pszSrc in den puffer kopiert werden sollen, der von pszDest bereitgestellt wird.

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 Zeichenfolge ohne Abschneiden kopiert 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. Der Zielpuffer enthält eine gekürzte Version der kopierten Zeichenfolge.
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 Wert zurück, wenn: Der Wert in cchDest ist größer als die maximale Puffergröße. Der Zielpuffer war bereits voll. Ein NULL-Zeiger war vorhanden. Die Länge des Zielpuffers war 0, aber eine Quellzeichenfolge mit ungleicher Länge war vorhanden.

Hinweise

Anstelle von strncpy sollten RtlStringCchCopyNW und RtlStringCchCopyNA verwendet werden.

Die Funktionen kopieren eine bestimmte Anzahl von Zeichen aus einer Quellzeichenfolge. RtlStringCchCopyNW und RtlStringCchCopyNA erhalten die Größe des Zielpuffers in Zeichen, um sicherzustellen, dass die Funktionen nicht über das Ende des Puffers schreiben.

Beachten Sie, dass sich diese Funktionen in einer Hinsicht anders verhalten als strncpy . Wenn cchSrc größer ist als die Anzahl der Zeichen in pszSrc, RtlStringCchCopyNW und RtlStringCchCopyNA – im Gegensatz zu strncpy –, sollten Sie pszDest erst dann mit NULL-Zeichen versehen, wenn cchSrc-Zeichen kopiert wurden.

Verwenden Sie RtlStringCchCopyNW zum Behandeln von Unicode-Zeichenfolgen und RtlStringCchCopyNA zum Verarbeiten von ANSI-Zeichenfolgen. Das von Ihnen verwendete Formular hängt von Ihren Daten ab, wie in der folgenden Tabelle gezeigt.

String-Datentyp	Zeichenfolgenliteral	Funktion
WCHAR	L"Zeichenfolge"	RtlStringCchCopyNW
char	„String“	RtlStringCchCopyNA

 

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

Weder pszSrc noch pszDest können NULL sein. Wenn Sie NULL-Zeichenfolgenzeigerwerte verarbeiten müssen, verwenden Sie RtlStringCchCopyNEx.

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

RtlStringCbCopyN

RtlStringCchCopy

RtlStringCchCopyNEx