RtlStringCbVPrintfExA-Funktion (ntstrsafe.h)
Die Funktionen RtlStringCbVPrintfExW und RtlStringCbVPrintfExA erstellen eine bytegezählte Textzeichenfolge mit Formatierung, die auf den angegebenen Formatierungsinformationen basiert.
Syntax
NTSTRSAFEDDI RtlStringCbVPrintfExA(
[out, optional] NTSTRSAFE_PSTR pszDest,
[in] size_t cbDest,
[out, optional] NTSTRSAFE_PSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags,
[in, optional] NTSTRSAFE_PCSTR pszFormat,
[in] va_list argList
);
Parameter
[out, optional] pszDest
Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine formatierte, NULL-endende Zeichenfolge empfängt. Die Funktion erstellt diese Zeichenfolge sowohl aus der formatierungszeichenfolge, die von pszFormat bereitgestellt wird, als auch aus den von argList bereitgestellten Argumenten. 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 sein, um die formatierte Zeichenfolge plus das abschließende NULL-Zeichen zu enthalten.
Bei 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.
[out, optional] ppszDestEnd
Wenn der Aufrufer einen Adresszeiger ungleich NULL bereitstellt, lädt die Funktion diese Adresse nach Abschluss des Vorgangs 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, die im Puffer enthalten sind, auf die von pszDest verwiesen wird, einschließlich der Bytes, die für das abschließende NULL-Zeichen verwendet werden.
[in] dwFlags
Mindestens ein Flag und optional ein Füllbyte. Die Flags werden wie folgt definiert:
[in, optional] pszFormat
Ein Zeiger auf eine mit NULL endende Textzeichenfolge, die Formatierungsdirektiven im Printf-Stil enthält. Der pszFormat-Zeiger kann NULL sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlags festgelegt ist.
[in] argList
Eine va_list typisierte Argumentliste. Argumente, die in der Argumentliste enthalten sind, werden mithilfe der formatierungszeichenfolge interpretiert, die von pszFormat bereitgestellt wird.
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 |
---|---|
|
Dieser Erfolg status bedeutet, dass Quelldaten vorhanden waren, die Ausgabezeichenfolge ohne Abschneiden erstellt wurde und der resultierende Zielpuffer NULL-beendet ist. |
|
Diese Warnung status bedeutet, dass der Vorgang aufgrund unzureichenden Speicherplatzes im Zielpuffer nicht abgeschlossen wurde. Wenn STRSAFE_NO_TRUNCATION in dwFlags festgelegt ist, wird der Zielpuffer nicht geändert. Wenn das Flag nicht festgelegt ist, enthält der Zielpuffer eine abgeschnittene Version der erstellten Zeichenfolge. |
|
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
RtlStringCbVPrintfExW und RtlStringCbVPrintfExA sollten anstelle der folgenden Funktionen verwendet werden:
- vsprintf
- vswprintf
- _vsnprintf
- _vsnwprintf
RtlStringCbVPrintfExW und RtlStringCbVPrintfExA fügen der Funktionalität von RtlStringCbVPrintf hinzu, indem sie einen Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl der Bytes zurückgeben, die in dieser Zeichenfolge nicht verwendet werden. Flags können zur zusätzlichen Steuerung an die Funktion übergeben werden.
Weitere Informationen zu va_list typisierten Argumentlisten finden Sie in der Microsoft Windows SDK-Dokumentation.
Verwenden Sie RtlStringCbVPrintfExW zum Verarbeiten von Unicode-Zeichenfolgen und RtlStringCbVPrintfExA 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" | RtlStringCbVPrintfExW |
char | „String“ | RtlStringCbVPrintfExA |
Wenn pszDest und pszFormat auf überlappende Zeichenfolgen verweisen oder sich Argumentzeichenfolgen überlappen, ist das Verhalten der Funktion nicht definiert.
Weder pszFormat noch pszDest kann 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 pszFormat 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