RtlStringCbCopyNA-Funktion (ntstrsafe.h)

Artikel
05/03/2024

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

Syntax

NTSTRSAFEDDI RtlStringCbCopyNA(
  [out] NTSTRSAFE_PSTR pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_PCNZCH pszSrc,
        size_t         cbToCopy
);

Parameter

[out] pszDest

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

[in] cbDest

Die Größe des Zielpuffers in Bytes. Der Puffer muss groß genug für die Zeichenfolge und das abschließende NULL-Zeichen sein.

Für Unicode-Zeichenfolgen beträgt die maximale Anzahl von Bytes NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Für ANSI-Zeichenfolgen beträgt die maximale Anzahl von Bytes NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

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

cbToCopy

Die maximale Anzahl von Bytes, die von pszSrc nach pszDest kopiert 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 Abschneiden kopiert 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 war vorhanden. Die Länge des Zielpuffers war null, aber eine Quellzeichenfolge ungleich null war vorhanden.

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 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 war vorhanden.
Die Länge des Zielpuffers war null, aber eine Quellzeichenfolge ungleich null war vorhanden.

Hinweise

RtlStringCbCopyNW und RtlStringCbCopyNA sollten anstelle von strncpy verwendet werden. Diese Funktionen unterscheiden sich jedoch im Verhalten. Wenn cbSrc größer als die Anzahl der Bytes in pszSrc ist, füllen die RtlStringCbCopyN-Funktionen – im Gegensatz zu strncpy – pszDest erst mit NULL-Zeichen, wenn cbSrc-Bytes kopiert wurden.

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

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

String-Datentyp	Zeichenfolgenliteral	Funktion
WCHAR	L"string"	RtlStringCbCopyNW
char	„String“	RtlStringCbCopyNA

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, lesen Sie RtlStringCbCopyNEx.

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	Alle, wenn Zeichenfolgen, die bearbeitet werden, immer im Arbeitsspeicher gespeichert sind, andernfalls PASSIVE_LEVEL

Weitere Informationen

RtlStringCbCopy

RtlStringCbCopyNEx

RtlStringCchCopyN

Freigeben über