RtlStringCbCopyNW-Funktion (ntstrsafe.h)

Artikel
02/07/2025

Die funktionen RtlStringCbCopyNW und RtlStringCbCopyNA funktionen kopieren eine byte-gezählte Zeichenfolge in einen Puffer, während die Größe der kopierten Zeichenfolge eingeschränkt wird.

Syntax

NTSTRSAFEDDI RtlStringCbCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cbToCopy
);

Parameter

[out] pszDest

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

[in] cbDest

Die Größe des Zielpuffers in Bytes. Der Puffer muss sowohl für die Zeichenfolge als auch für das endende Nullzeichen groß genug sein.

Bei Unicode-Zeichenfolgen ist die maximale Anzahl von Bytes NTSTRSAFE_MAX_CCH * Sizeof(WCHAR).

Bei ANSI-Zeichenfolgen ist die maximale Anzahl von Bytes NTSTRSAFE_MAX_CCH * Größe(Zeichen).

[in] pszSrc

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

cbToCopy

Die maximale Anzahl von Bytes, die von pszSrc in pszDestkopiert werden sollen.

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 Abkürzung kopiert wurde und der resultierende Zielpuffer null beendet ist.
STATUS_BUFFER_OVERFLOW	Diese Warnung Status bedeutet, dass der Kopiervorgang aufgrund unzureichendem Speicherplatz im Zielpuffer nicht abgeschlossen wurde. Der Zielpuffer enthält eine abgeschnittene Version der kopierten Zeichenfolge.
STATUS_INVALID_PARAMETER	Dieser Fehler Status bedeutet, dass die Funktion einen ungültigen Eingabeparameter empfangen hat. Weitere Informationen finden Sie im folgenden Absatz. Die Funktion gibt den STATUS_INVALID_PARAMETER Wert zurück, wenn: Der Wert in cbDest- ist größer als die maximale Puffergröße. Der Zielpuffer war bereits voll. Ein NULL- Zeiger vorhanden war. Die Länge des Zielpuffers war null, aber eine Zeichenfolge mit nicht nuller Länge war vorhanden.

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_BUFFER_OVERFLOW

Diese Warnung Status bedeutet, dass der Kopiervorgang aufgrund unzureichendem Speicherplatz im Zielpuffer nicht abgeschlossen wurde. Der Zielpuffer enthält eine abgeschnittene Version der kopierten Zeichenfolge.

STATUS_INVALID_PARAMETER

Dieser Fehler Status bedeutet, dass die Funktion einen ungültigen Eingabeparameter empfangen hat. Weitere Informationen finden Sie im folgenden Absatz.

Die Funktion gibt den STATUS_INVALID_PARAMETER Wert zurück, wenn:

Der Wert in cbDest- ist größer als die maximale Puffergröße.
Der Zielpuffer war bereits voll.
Ein NULL- Zeiger vorhanden war.
Die Länge des Zielpuffers war null, aber eine Zeichenfolge mit nicht nuller Länge war vorhanden.

Bemerkungen

RtlStringCbCopyNW und RtlStringCbCopyNA sollten anstelle strncpyverwendet werden. Diese Funktionen unterscheiden sich jedoch im Verhalten. Wenn cbSrc- größer als die Anzahl der Bytes in pszSrcist, werden die RtlStringCbCopyN--Funktionen - im Gegensatz zu strncpy- nicht pszDest mit NULL-Zeichen gefüllt, bis cbSrc Bytes kopiert wurden.

RtlStringCbCopyN kopiert eine bestimmte Anzahl von Bytes aus einer Quellzeichenfolge. Die Größe des Zielpuffers in Bytes wird der Funktion bereitgestellt, um sicherzustellen, dass RtlStringCbCopyN- nicht über das Ende dieses Puffers schreibt.

Verwenden Sie RtlStringCbCopyNW- zum Behandeln von Unicode-Zeichenfolgen und RtlStringCbCopyNA- zum Behandeln von ANSI-Zeichenfolgen. Das von Ihnen verwendete Formular hängt von Ihren Daten ab, wie in der folgenden Tabelle dargestellt.

Zeichenfolgendatentyp	Zeichenfolgenliteral	Funktion
WCHAR	L"string"	RtlStringCbCopyNW-
Zeichen-	"string"	RtlStringCbCopyNA-

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

Weder pszSrc noch pszDest kann NULLsein. Wenn Sie NULL- Zeichenfolgenzeigerwerte behandeln müssen, lesen Sie RtlStringCbCopyNEx.

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

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Verfügbar in Windows XP mit Service Pack 1 (SP1) und höheren Versionen von Windows.
Zielplattform-	Desktop
Header-	ntstrsafe.h (include Ntstrsafe.h)
Library	Ntstrsafe.lib
IRQL-	Wenn Zeichenfolgen, die bearbeitet werden, immer im Arbeitsspeicher vorhanden sind, andernfalls PASSIVE_LEVEL

Siehe auch

RtlStringCbCopy-

RtlStringCbCopyNEx-

RtlStringCchCopyN-

Freigeben über