RtlStringCchCopyW-Funktion (ntstrsafe.h)

Die Funktionen RtlStringCchCopyW und RtlStringCchCopyA kopieren eine NULL-endende Quellzeichenfolge in einen Zielpuffer der angegebenen Länge.

Syntax

NTSTRSAFEDDI RtlStringCchCopyW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  NTSTRSAFE_PCWSTR pszSrc
);

Parameter

[out] pszDest

Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der die kopierte Zeichenfolge empfängt. Die Zeichenfolge bei pszSrc wird in den Puffer bei pszDest 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.

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 Pufferspeichers nicht abgeschlossen wurde. Der Zielpuffer enthält eine abgeschnittene, NULL-beendete Version des beabsichtigten Ergebnisses.
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. Ein NULL-Zeiger war vorhanden. Die Zielpufferlänge war beim Einstieg 0.

Hinweise

RtlStringCchCopyW und RtlStringCchCopyA sollten anstelle der folgenden Funktionen verwendet werden:

• strcpy
• wcscpy

Diese Funktionen ersetzen strncpy nicht. Verwenden Sie RtlStringCchCopyN oder RtlStringCchCopyNEx , um strncpy zu ersetzen.

Die Größe des Zielpuffers in Zeichen wird für RtlStringCchCopyW und RtlStringCchCopyA bereitgestellt, um sicherzustellen, dass sie nicht über das Ende des Puffers hinaus schreiben.

Verwenden Sie RtlStringCchCopyW zum Behandeln von Unicode-Zeichenfolgen und RtlStringCchCopyA 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"	RtlStringCchCopyW
char	„String“	RtlStringCchCopyA

 

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 RtlStringCchCopyEx.

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

RtlStringCbCopy

RtlStringCchCopyEx