RtlStringCchCopyNExW-Funktion (ntstrsafe.h)
Die Funktionen RtlStringCchCopyNExW und RtlStringCchCopyNExA kopieren eine zeichengezählte Zeichenfolge in einen Puffer, während die Größe der kopierten Zeichenfolge begrenzt wird.
Syntax
NTSTRSAFEDDI RtlStringCchCopyNExW(
[out, optional] NTSTRSAFE_PWSTR pszDest,
[in] size_t cchDest,
[in, optional] STRSAFE_PCNZWCH pszSrc,
size_t cchToCopy,
[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 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] cchDest
Die Größe des Zielpuffers in Zeichen. Die maximale Anzahl zulässiger Zeichen ist NTSTRSAFE_MAX_CCH. Wenn pszDestNULL ist, muss cchDest null sein.
[in, optional] pszSrc
Ein Zeiger auf eine vom Aufrufer bereitgestellte, null-endende Zeichenfolge.
cchToCopy
Die maximale Anzahl von Zeichen, die aus *pszSrc* in den puffer kopiert werden sollen, der von *pszDest* bereitgestellt wird.
[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] pcchRemaining
Wenn der Aufrufer einen Adresszeiger ungleich NULL bereitstellt, lädt die Funktion die Adresse mit der Anzahl nicht verwendeter Zeichen, auf die im Puffer von pszDest verwiesen wird, einschließlich des abschließenden NULL-Zeichens.
[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:
|
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 in dwFlags 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:
|
Hinweise
RtlStringCchCopyNExW und RtlStringCchCopyNExA sollten anstelle von strncpy verwendet werden. Die Funktionen kopieren eine bestimmte Anzahl von Zeichen aus einer Quellzeichenfolge. Die Größe des Zielpuffers in Zeichen wird für RtlStringCchCopyNExW und RtlStringCchCopyNExA bereitgestellt, um sicherzustellen, dass sie nicht über das Ende des Puffers hinaus schreiben.
Beachten Sie, dass sich diese Funktionen in einer Hinsicht anders verhalten als strncpy . Wenn cchSrc größer ist als die Anzahl der Zeichen in pszSrc, RtlStringCchCopyNExW und RtlStringCchCopyNExA – im Gegensatz zu strncpy –, sollten Sie pszDest erst dann mit NULL-Zeichen versehen, wenn cchSrc-Zeichen kopiert wurden.
RtlStringCchCopyNExW und RtlStringCchCopyNExA fügen der Funktionalität von RtlStringCchCopyN hinzu, indem sie einen Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl der Zeichen zurückgeben, die in dieser Zeichenfolge nicht verwendet werden. Flags können zur zusätzlichen Steuerung an die Funktion übergeben werden.
Verwenden Sie RtlStringCchCopyNExW zum Verarbeiten von Unicode-Zeichenfolgen und RtlStringCchCopyNExA 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" | RtlStringCchCopyNExW |
char | „String“ | RtlStringCchCopyNExA |
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 | PASSIVE_LEVEL |
Weitere Informationen
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für