RtlStringCbCopyNExA-Funktion (ntstrsafe.h)

Artikel
05/03/2024

Die Funktionen RtlStringCbCopyNExW und RtlStringCbCopyNExA kopieren eine bytegezählte Zeichenfolge in einen Puffer, während die Größe der kopierten Zeichenfolge begrenzt 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 in den Puffer unter 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] 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)

Wenn pszDestNULL ist, muss cbDest null sein.

[in, optional] pszSrc

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

cbToCopy

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

[out, optional] ppszDestEnd

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

[out, optional] pcbRemaining

Wenn der Aufrufer einen Adresszeiger ungleich NULL bereitstellt, lädt die Funktion die Adresse mit der Anzahl nicht verwendeter Bytes, auf die im Puffer von pszDest verwiesen wird, einschließlich der Bytes, die für das beendende NULL-Zeichen verwendet werden.

[in] dwFlags

Mindestens ein Flag 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 auf das abschließende 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 aufzufü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 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 Flag angegeben. Der Wert in cbDest ist größer als die maximale Puffergröße. Der Zielpuffer war bereits voll. Ein NULL-Zeiger war ohne das flag STRSAFE_IGNORE_NULLS vorhanden. Der Zielpufferzeiger war NULL, aber die Puffergröße war nicht 0(0). Der Zielpufferzeiger war NULL, oder seine Länge 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. 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 Flag angegeben.
Der Wert in cbDest ist größer als die maximale Puffergröße.
Der Zielpuffer war bereits voll.
Ein NULL-Zeiger war ohne das flag STRSAFE_IGNORE_NULLS vorhanden.
Der Zielpufferzeiger war NULL, aber die Puffergröße war nicht 0(0).
Der Zielpufferzeiger war NULL, oder seine Länge war null, aber eine Quellzeichenfolge ungleich null war vorhanden.

Hinweise

RtlStringCbCopyNExW und RtlStringCbCopyNExA 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 RtlStringCbCopyNEx-Funktionen im Gegensatz zu strncpypszDest erst mit NULL-Zeichen, wenn 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 hinaus schreiben.

RtlStringCbCopyNEx fügt der Funktionalität von RtlStringCbCopyN hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl der Bytes zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet werden. Flags können auch zur zusätzlichen Steuerung an die Funktion übergeben werden.

Verwenden Sie RtlStringCbCopyNExW zum Verarbeiten von Unicode-Zeichenfolgen und RtlStringCbCopyNExA 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"	RtlStringCbCopyNExW
char	„String“	RtlStringCbCopyNExA

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

Weder pszSrc noch pszDest können NULL sein, es sei denn, das STRSAFE_IGNORE_NULLS-Flag ist festgelegt. In diesem Fall kann eines 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	Alle, wenn Zeichenfolgen, die bearbeitet werden, immer im Arbeitsspeicher gespeichert sind, andernfalls PASSIVE_LEVEL