RtlStringCbPrintfA-Funktion (ntstrsafe.h)
Die Funktionen RtlStringCbPrintfW und RtlStringCbPrintfA erstellen eine bytegezählte Textzeichenfolge mit Formatierung, die auf den angegebenen Formatierungsinformationen basiert.
Syntax
NTSTRSAFEDDI RtlStringCbPrintfA(
[out] NTSTRSAFE_PSTR pszDest,
[in] size_t cbDest,
[in] NTSTRSAFE_PCSTR pszFormat,
...
);
Parameter
[out] 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.
[in] cbDest
Die Größe des Zielpuffers in Bytes. Der Puffer muss groß genug sein, um die formatierte Zeichenfolge plus das beendende NULL-Zeichen zu enthalten.
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).
[in] pszFormat
Ein Zeiger auf eine Textzeichenfolge mit NULL-Beendigung, die Formatierungsdirektiven im Printf-Format enthält.
...
Eine Liste von Argumenten, die von der Funktion basierend auf Formatierungsdirektiven interpretiert werden, die in der Zeichenfolge pszFormat 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 Zeichenfolge 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. Der Zielpuffer enthält eine gekürzte Version der Ausgabezeichenfolge. |
|
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
RtlStringCbPrintfW und RtlStringCbPrintfA sollten anstelle der folgenden Funktionen verwendet werden:
- sprintf
- swprintf
- _snprintf
- _snwprintf
Verwenden Sie RtlStringCbPrintfW zum Behandeln von Unicode-Zeichenfolgen und RtlStringCbPrintfA 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" | RtlStringCbPrintfW |
char | „String“ | RtlStringCbPrintfA |
Wenn pszDest und pszFormat auf eine überlappende Zeichenfolge verweisen oder sich Argumentzeichenfolgen überlappen, ist das Verhalten der Funktion nicht definiert.
Weder pszFormat noch pszDest kann NULL sein. Wenn Sie NULL-Zeichenfolgenzeigerwerte verarbeiten müssen, verwenden Sie RtlStringCbPrintfEx.
Weitere Informationen zu den Sicheren Zeichenfolgenfunktionen finden Sie unter Verwenden sicherer Zeichenfolgenfunktionen.
Beispiele
Das folgende Beispiel zeigt eine einfache Verwendung von RtlStringCbPrintfW unter Verwendung von vier Argumenten.
int const arraysize = 30;
WCHAR pszDest[arraysize];
size_t cbDest = arraysize * sizeof(WCHAR);
LPCWSTR pszFormat = L"%s %d + %d = %d.";
WCHAR* pszTxt = L"The answer is";
NTSTATUS status = RtlStringCbPrintfW(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);
Die resultierende Zeichenfolge lautet "Die Antwort ist 1 + 2 = 3". Sie ist im Puffer bei pszDest enthalten.
Anforderungen
Anforderung | Wert |
---|---|
Unterstützte Mindestversion (Client) | Verfügbar ab Windows XP mit Service Pack 1 (SP1). |
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 |