RtlStringCchCopyNExA-Funktion (ntstrsafe.h)
Die RtlStringCchCopyNExW und RtlStringCchCopyNExA- Funktionen kopieren eine Zeichenfolge mit Zeichenanzahl in einen Puffer, während die Größe der kopierten Zeichenfolge eingeschränkt wird.
Syntax
NTSTRSAFEDDI RtlStringCchCopyNExA(
[out, optional] NTSTRSAFE_PSTR pszDest,
[in] size_t cchDest,
[in, optional] STRSAFE_PCNZCH pszSrc,
size_t cchToCopy,
[out, optional] NTSTRSAFE_PSTR *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 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] cchDest
Die Größe des Zielpuffers in Zeichen. Die maximale Anzahl zulässiger Zeichen ist NTSTRSAFE_MAX_CCH. Wenn pszDest-NULL-ist, muss cchDest- null sein.
[in, optional] pszSrc
Ein Zeiger auf eine vom Aufrufer bereitgestellte, null-beendete Zeichenfolge.
cchToCopy
Die maximale Anzahl von Zeichen, die von pszSrc in den Puffer kopiert werden sollen, der von pszDestbereitgestellt wird.
[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] pcchRemaining
Wenn der Aufrufer einen null-NULL- Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl nicht verwendeter Zeichen, die im Puffer enthalten sind, auf pszDestverweist, einschließlich des endenden NULL-Zeichens.
[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:
|
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 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:
|
Bemerkungen
RtlStringCchCopyNExW und RtlStringCchCopyNExA sollten anstelle strncpyverwendet werden. Die Funktionen kopieren eine bestimmte Anzahl von Zeichen aus einer Quellzeichenfolge. Die Größe des Zielpuffers wird in Zeichen für RtlStringCchCopyNExW- und RtlStringCchCopyNExA- bereitgestellt, um sicherzustellen, dass sie nicht über das Ende des Puffers schreiben.
Beachten Sie, dass sich diese Funktionen anders verhalten als strncpy- in einer Hinsicht. Wenn cchSrc größer als die Anzahl der Zeichen in pszSrcist, RtlStringCchCopyNExW und RtlStringCchCopyNExA-– im Gegensatz zu strncpy– setzen Sie pszDest- mit NULL-Zeichen nicht fort, bis cchSrc Zeichen kopiert wurden.
RtlStringCchCopyNExW und RtlStringCchCopyNExA zur Funktionalität von RtlStringCchCopyN hinzufügen, indem ein Zeiger an das Ende der Zielzeichenfolge sowie die Anzahl der zeichen zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet wurden. Flags können für zusätzliche Steuerelemente an die Funktion übergeben werden.
Verwenden Sie RtlStringCchCopyNExW- zum Behandeln von Unicode-Zeichenfolgen und RtlStringCchCopyNExA- 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" | RtlStringCchCopyNExW- |
Zeichen- | "string" | RtlStringCchCopyNExA |
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 |