RtlStringCchPrintfExW-Funktion (ntstrsafe.h)
Die Funktionen RtlStringCchPrintfExW und RtlStringCchPrintfExA erstellen eine zeichengezählte Textzeichenfolge mit Formatierung, die auf den angegebenen Formatierungsinformationen basiert.
Syntax
NTSTRSAFEDDI RtlStringCchPrintfExW(
[out, optional] NTSTRSAFE_PWSTR pszDest,
[in] size_t cchDest,
[out, optional] NTSTRSAFE_PWSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags,
[in] NTSTRSAFE_PCWSTR pszFormat,
...
);
Parameter
[out, optional] pszDest
Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine formatierte NULL-Zeichenfolge empfängt. Die Funktion erstellt diese Zeichenfolge sowohl aus der Formatierungszeichenfolge, die von pszFormat bereitgestellt wird, als auch aus der Argumentliste der Funktion. 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. Der Puffer muss groß genug sein, um die formatierte Zeichenfolge plus das beendende NULL-Zeichen zu enthalten. Die maximal zulässige Anzahl von Zeichen ist NTSTRSAFE_MAX_CCH. Wenn pszDestNULL ist, muss cchDest 0 sein.
[out, optional] ppszDestEnd
Wenn der Aufrufer einen Nicht-NULL-Adresszeiger bereitstellt, lädt die Funktion nach Abschluss des Vorgangs diese Adresse mit einem Zeiger auf den resultierenden NULL-Zeichenfolgenabschluss des Zielpuffers.
[out, optional] pcchRemaining
Wenn der Aufrufer einen Nicht-NULL-Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl der nicht verwendeten Zeichen im Puffer, auf die von pszDest verwiesen wird, einschließlich des beendenden NULL-Zeichens.
[in] dwFlags
Ein oder mehrere Flags und optional ein Füllbyte. Die Flags werden wie folgt definiert:
[in] pszFormat
Ein Zeiger auf eine Textzeichenfolge mit NULL-Beendigung, die Formatierungsdirektiven im Printf-Format enthält. Der pszFormat-Zeiger kann NULL sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlags festgelegt ist.
...
Eine optionale Liste von Argumenten, die von der Funktion interpretiert werden, basierend auf Formatierungsdirektiven, die in der pszFormat-Zeichenfolge enthalten sind.
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 des 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 erhalten hat. Weitere Informationen finden Sie im folgenden Absatz.
Die Funktion gibt den STATUS_INVALID_PARAMETER Wert zurück, wenn:
|
Hinweise
RtlStringCchPrintfExW und RtlStringCchPrintfExA sollten anstelle der folgenden Funktionen verwendet werden:
- sprintf
- swprintf
- _snprintf
- _snwprintf
RtlStringCchPrintfExW und RtlStringCchPrintfExA fügen der Funktionalität von RtlStringCchPrintf hinzu, indem sie einen Zeiger auf das Ende der Zielzeichenfolge zurückgeben, sowie die Anzahl der Zeichen, die in dieser Zeichenfolge nicht verwendet werden. Flags können für ein zusätzliches Steuerelement an die Funktion übergeben werden.
Verwenden Sie RtlStringCchPrintfExW zum Behandeln von Unicode-Zeichenfolgen und RtlStringCchPrintfExA zum Verarbeiten von ANSI-Zeichenfolgen. Das von Ihnen verwendete Formular hängt von Ihren Daten ab, wie in der folgenden Tabelle gezeigt.
String-Datentyp | Zeichenfolgenliteral | Funktion |
---|---|---|
WCHAR | L"Zeichenfolge" | RtlStringCchPrintfExW |
char | „String“ | RtlStringCchPrintfExA |
Wenn pszDest und pszFormat auf überlappende Zeichenfolgen verweisen oder sich alle Argumentzeichenfolgen überlappen, 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 | 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