Freigeben über


RtlStringCchCopyNA-Funktion (ntstrsafe.h)

Die RtlStringCchCopyNW und RtlStringCchCopyNA- Funktionen kopieren eine Zeichenfolge mit Zeichenanzahl in einen Puffer, während die Größe der kopierten Zeichenfolge eingeschränkt wird.

Syntax

NTSTRSAFEDDI RtlStringCchCopyNA(
  [out] NTSTRSAFE_PSTR pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH 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 an den Puffer bei pszDest kopiert und mit einem NULL-Zeichen beendet.

[in] cchDest

Die Größe des Zielpuffers in Zeichen. Die maximale Anzahl zulässiger Zeichen ist NTSTRSAFE_MAX_CCH.

[in] pszSrc

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

cchToCopy

Die maximale Anzahl von Zeichen, die von pszSrc in den Puffer kopiert werden sollen, der von pszDestbereitgestellt 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 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 cchDest- 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

RtlStringCchCopyNW und RtlStringCchCopyNA sollten anstelle strncpyverwendet werden.

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

Beachten Sie, dass sich diese Funktionen anders verhalten als strncpy- in einer Hinsicht. Wenn cchSrc größer als die Anzahl der Zeichen in pszSrcist, RtlStringCchCopyNW und RtlStringCchCopyNA– im Gegensatz zu strncpy– setzen Sie pszDest- mit NULL-Zeichen nicht fort, bis cchSrc Zeichen kopiert wurden.

Verwenden Sie RtlStringCchCopyNW- zum Behandeln von Unicode-Zeichenfolgen und RtlStringCchCopyNA- 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" RtlStringCchCopyNW
Zeichen- "string" RtlStringCchCopyNA
 

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, verwenden Sie RtlStringCchCopyNEx-.

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

RtlStringCbCopyN-

RtlStringCchCopy

RtlStringCchCopyNEx-