Freigeben über

RtlStringCbCopyNExA-Funktion (ntstrsafe.h)

  • Artikel

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

Syntax

NTSTRSAFEDDI RtlStringCbCopyNExA(
  [out, optional] NTSTRSAFE_PSTR pszDest,
  [in]            size_t         cbDest,
  [in, optional]  STRSAFE_PCNZCH pszSrc,
                  size_t         cbToCopy,
  [out, optional] NTSTRSAFE_PSTR *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [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 bei pszDest- in den Puffer kopiert und mit einem Nullzeichen beendet. Der pszDest Zeiger kann NULL-sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlagsfestgelegt ist.

[in] cbDest

Die Größe des Zielpuffers in Bytes. Der Puffer muss groß genug für die Zeichenfolge und das endende Nullzeichen 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 * sizeof(char)

Wenn pszDest-NULL-ist, muss cbDest- null 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 dwFlagsfestgelegt ist.

cbToCopy

Die maximale Anzahl von Bytes, die von *pszSrc* in *pszDest* kopiert werden sollen.

[out, optional] ppszDestEnd

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

[out, optional] pcbRemaining

Wenn der Aufrufer einen null-NULL- Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl der nicht verwendeten Bytes, die im Puffer enthalten sind, auf pszDest-verwiesen wird, einschließlich der für das beendenden Nullzeichen verwendeten Bytes.

[in] dwFlags

Mindestens ein Flag und optional ein Füllbyte. Die Kennzeichen sind wie folgt definiert:

Wert Bedeutung
STRSAFE_FILL_BEHIND_NULL Wenn dieses Flag festgelegt ist und die Funktion erfolgreich ausgeführt wird, wird das niedrige Byte von dwFlags verwendet, um den Teil des Zielpuffers auszufüllen, der auf das endende Nullzeichen folgt.
STRSAFE_IGNORE_NULLS Wenn dieses Flag festgelegt ist, kann pszDest oder pszSrcoder beides NULL-sein. NULLpszSrc Zeiger werden wie leere Zeichenfolgen (TEXT("")) behandelt, die kopiert werden können. NULL-pszDest Zeiger können keine 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 auszufüllen, und der Puffer wird null-beendet. Mit diesem Vorgang werden alle bereits vorhandenen Pufferinhalte überschrieben.
STRSAFE_NULL_ON_FAILURE Wenn dieses Flag festgelegt ist und die Funktion fehlschlägt, wird der Zielpuffer auf eine leere Zeichenfolge (TEXT("")) festgelegt. Mit diesem Vorgang werden alle bereits vorhandenen Pufferinhalte überschrieben.
STRSAFE_NO_TRUNCATION

Wenn dieses Kennzeichen festgelegt ist und die Funktion STATUS_BUFFER_OVERFLOWzurückgibt:

  • Wenn STRSAFE_FILL_ON_FAILURE auch angegeben wird, 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 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. Wenn STRSAFE_NO_TRUNCATION festgelegt ist, finden Sie weitere Informationen im dwFlags-parameter.
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:

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

Bemerkungen

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

Die Größe des Zielpuffers in Bytes wird für RtlStringCbCopyNExW- und RtlStringCbCopyNExA- bereitgestellt, um sicherzustellen, dass sie nicht über das Ende dieses Puffers schreiben.

RtlStringCbCopyNEx der Funktionalität von RtlStringCbCopyN- hinzu, indem ein Zeiger an das Ende der Zielzeichenfolge sowie die Anzahl der bytes zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet wurden. Flags können auch an die Funktion übergeben werden, um zusätzliche Steuerelemente zu erhalten.

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

Wenn pszSrc und pszDest auf überlappende Zeichenfolgen zeigen, 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 beides NULL-sein. Wenn pszDest-NULL-ist, muss pszSrc entweder NULL- sein oder auf eine leere Zeichenfolge zeigen.

Weitere Informationen zu den funktionen für sichere Zeichenfolgen finden Sie unter Verwenden sicherer Zeichenfolgenfunktionen.

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