RtlStringCchCopyExW-Funktion (ntstrsafe.h)

  • Artikel

Die Funktionen RtlStringCchCopyExW und RtlStringCchCopyExA kopieren eine zeichengezählte Zeichenfolge in einen Puffer.

Syntax

NTSTRSAFEDDI RtlStringCchCopyExW(
  [out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [in, optional]  NTSTRSAFE_PCWSTR pszSrc,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcchRemaining,
  [in]            DWORD            dwFlags
);

Parameter

[out, optional] 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. Der pszDest-Zeiger kann NULL sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlags festgelegt ist.

[in] cchDest

Die Größe des Zielpuffers in Zeichen. Die maximal zulässige Anzahl von Zeichen ist NTSTRSAFE_MAX_CCH. Wenn pszDestNULL ist, muss cchDest 0 sein.

[in, optional] pszSrc

Ein Zeiger auf eine vom Aufrufer bereitgestellte, NULL-beendete Zeichenfolge. Der pszSrc-Zeiger kann NULL sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlags festgelegt ist.

[out, optional] ppszDestEnd

Wenn der Aufrufer einen Nicht-NULL-Adresszeiger bereitstellt, lädt die Funktion nach Abschluss des Kopiervorgangs diese Adresse mit einem Zeiger auf den resultierenden NULL-Zeichenfolgenabschluss des Zielpuffers.

[out, optional] pcchRemaining

Wenn der Aufrufer einen Nicht-NULL-Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl nicht verwendeter Zeichen, die sich im Puffer befinden, auf den von pszDest verwiesen wird, einschließlich des beendenden NULL-Zeichens.

[in] dwFlags

Ein oder mehrere Flags und optional ein Füllbyte. Die Flags werden wie folgt definiert:

Wert Bedeutung
STRSAFE_FILL_BEHIND_NULL Wenn dieses Flag festgelegt ist und die Funktion erfolgreich ist, wird das niedrige Byte von dwFlags verwendet, um den Teil des Zielpuffers zu füllen, der dem beendenden NULL-Zeichen folgt.
STRSAFE_IGNORE_NULLS Wenn dieses Flag festgelegt ist, kann entweder pszDest oder pszSrc oder beides NULL sein. NULLpszSrc-Zeiger werden wie leere Zeichenfolgen (TEXT("")) behandelt, die kopiert werden können. NULLpszDest-Zeiger können keine nicht leeren Zeichenfolgen empfangen.
STRSAFE_FILL_ON_FAILURE Wenn dieses Flag festgelegt ist und die Funktion fehlschlägt, wird das niedrige Byte von dwFlags verwendet, um den gesamten Zielpuffer zu füllen, und der Puffer ist NULL-beendet. Dieser Vorgang überschreibt alle bereits vorhandenen Pufferinhalte.
STRSAFE_NULL_ON_FAILURE Wenn dieses Flag festgelegt ist und die Funktion fehlschlägt, wird der Zielpuffer auf eine leere Zeichenfolge (TEXT("")) festgelegt. Dieser Vorgang überschreibt alle bereits vorhandenen Pufferinhalte.
STRSAFE_NO_TRUNCATION

Wenn dieses Flag festgelegt ist und die Funktion STATUS_BUFFER_OVERFLOW zurückgibt:

  • Wenn auch STRSAFE_FILL_ON_FAILURE angegeben ist, füllt STRSAFE_NO_TRUNCATION den Zielpuffer entsprechend aus.
  • Andernfalls wird der Inhalt des Zielpuffers auf eine leere Zeichenfolge festgelegt, auch wenn STRSAFE_NULL_ON_FAILURE nicht festgelegt ist. STRSAFE_FILL_BEHIND_NULL wird ignoriert.

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. Wenn STRSAFE_NO_TRUNCATION in dwFlags festgelegt ist, wird der Zielpuffer nicht geändert. Wenn das Flag nicht festgelegt ist, enthält der Zielpuffer eine abgeschnittene Version der erstellten 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:

  • Es wurde ein ungültiges Flag angegeben.
  • Der Wert in cchDest ist größer als die maximale Puffergröße.
  • Der Zielpuffer war bereits voll.
  • Ein NULL-Zeiger war ohne das STRSAFE_IGNORE_NULLS-Flag vorhanden.
  • Der Zielpufferzeiger war NULL, aber die Puffergröße war nicht 0.
  • Der Zielpufferzeiger war NULL, oder seine Länge war 0, aber eine Quellzeichenfolge mit ungleicher Länge war vorhanden.

Hinweise

RtlStringCchCopyExW und RtlStringCchCopyExA sollten anstelle der folgenden Funktionen verwendet werden:

  • strcpy
  • wcscpy

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

RtlStringCchCopyExW und RtlStringCchCopyExA fügen der Funktionalität von RtlStringCchCopy hinzu, indem sie einen Zeiger auf das Ende der Zielzeichenfolge zurückgeben, sowie die Anzahl der Zeichen, die in dieser Zeichenfolge nicht verwendet werden. Flags können für ein zusätzliches Steuerelement an die Funktion übergeben werden. Verwenden Sie RtlStringCchCopyExW zum Behandeln von Unicode-Zeichenfolgen und RtlStringCchCopyExA 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" RtlStringCchCopyExW
char „String“ RtlStringCchCopyExA

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

Weder pszSrc noch pszDest kann NULL sein, es sei denn, das STRSAFE_IGNORE_NULLS-Flag ist festgelegt. In diesem Fall kann entweder oder beide NULL sein. Wenn pszDestNULL ist, muss pszSrc entweder NULL sein oder auf eine leere Zeichenfolge zeigen.

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