RtlStringCbCopyExA-Funktion (ntstrsafe.h)
Die Funktionen RtlStringCbCopyExW und RtlStringCbCopyExA kopieren eine bytegezählte Zeichenfolge in einen Puffer.
Syntax
NTSTRSAFEDDI RtlStringCbCopyExA(
[out, optional] NTSTRSAFE_PSTR pszDest,
[in] size_t cbDest,
[in, optional] NTSTRSAFE_PCSTR pszSrc,
[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 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] cbDest
Die Größe des Zielpuffers in Bytes. Der Puffer muss groß genug für die Zeichenfolge und das beendende 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-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 diese Adresse nach Abschluss des Kopiervorgangs mit einem Zeiger auf den resultierenden NULL-Zeichenfolgenabschluss des Zielpuffers.
[out, optional] pcbRemaining
Wenn der Aufrufer einen Nicht-NULL-Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl der nicht verwendeten Bytes, die sich im Puffer befinden, auf die von pszDest verwiesen wird, einschließlich Bytes, die für das beendende NULL-Zeichen verwendet werden.
[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:
|
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 festgelegt ist, finden Sie weitere Informationen im dwFlags-Parameter . |
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:
|
Hinweise
Anstelle der folgenden Funktionen sollten RtlStringCbCopyExA und RtlStringCbCopyExW verwendet werden:
- strcpy
- wcscpy
Die Größe des Zielpuffers in Bytes wird für RtlStringCbCopyExA und RtlStringCbCopyExW bereitgestellt, um sicherzustellen, dass sie nicht über das Ende des Puffers schreiben.
RtlStringCbCopyEx fügt die Funktionalität von RtlStringCbCopy 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 für ein zusätzliches Steuerelement an die Funktion übergeben werden.
Verwenden Sie RtlStringCbCopyExW zum Behandeln von Unicode-Zeichenfolgen und RtlStringCbCopyExA zum Behandeln von ANSI-Zeichenfolgen. Das von Ihnen verwendete Formular hängt von Ihren Daten ab, wie in der folgenden Tabelle dargestellt.
String-Datentyp | Zeichenfolgenliteral | Funktion |
---|---|---|
WCHAR | L"Zeichenfolge" | RtlStringCbCopyExW |
char | „String“ | RtlStringCbCopyExA |
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 | Alle, wenn Zeichenfolgen, die bearbeitet werden, immer im Arbeitsspeicher gespeichert sind, andernfalls 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