RtlStringCbVPrintfW-Funktion (ntstrsafe.h)

Artikel
05/03/2024

Die Funktionen RtlStringCbVPrintfW und RtlStringCbVPrintfA erstellen eine bytegezählte Textzeichenfolge mit Formatierung, die auf den angegebenen Formatierungsinformationen basiert.

Syntax

NTSTRSAFEDDI RtlStringCbVPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
  [in]  va_list          argList
);

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 den von argList bereitgestellten Argumenten.

[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.

[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
STATUS_SUCCESS	Dieser Erfolg status bedeutet, dass Quelldaten vorhanden waren, die Ausgabezeichenfolge ohne Abschneiden erstellt wurde und der resultierende Zielpuffer NULL-beendet ist.
STATUS_BUFFER_OVERFLOW	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 erstellten Zeichenfolge.
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: Der Wert in cbDest ist größer als die maximale Puffergröße. Der Zielpuffer war bereits voll. Ein NULL-Zeiger war vorhanden. Die Zielpufferlänge war 0, aber eine Quellzeichenfolge mit ungleicher Länge war vorhanden.

Rückgabecode

Beschreibung

STATUS_SUCCESS

Dieser Erfolg status bedeutet, dass Quelldaten vorhanden waren, die Ausgabezeichenfolge ohne Abschneiden erstellt wurde und der resultierende Zielpuffer NULL-beendet ist.

STATUS_BUFFER_OVERFLOW

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 erstellten Zeichenfolge.

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:

Der Wert in cbDest ist größer als die maximale Puffergröße.
Der Zielpuffer war bereits voll.
Ein NULL-Zeiger war vorhanden.
Die Zielpufferlänge war 0, aber eine Quellzeichenfolge mit ungleicher Länge war vorhanden.

Hinweise

Anstelle der folgenden Funktionen sollten RtlStringCbVPrintfW und RtlStringCbVPrintfA verwendet werden:

vsprintf
vswprintf
_vsnprintf
_vsnwprintf

Alle diese Funktionen akzeptieren eine Formatzeichenfolge zusammen mit einem Satz von Argumenten in einer va_list typisierten Argumentliste und geben eine formatierte Zeichenfolge zurück. Die Größe des Zielpuffers in Bytes wird für RtlStringCbVPrintfW und RtlStringCbVPrintfA bereitgestellt, um sicherzustellen, dass sie nicht über das Ende des Puffers schreiben.

Weitere Informationen zu va_list typisierten Argumentlisten finden Sie in der Microsoft Windows SDK-Dokumentation.

Verwenden Sie RtlStringCbVPrintfW zum Behandeln von Unicode-Zeichenfolgen und RtlStringCbVPrintfA 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"	RtlStringCbVPrintfW
char	„String“	RtlStringCbVPrintfA

Wenn pszDest und pszFormat auf überlappende Zeichenfolgen verweisen oder sich Argumentzeichenfolgen überschneiden, ist das Verhalten der Funktion nicht definiert..

Weder pszFormat noch pszDest sollte NULL sein. Wenn Sie NULL-Zeichenfolgenzeigerwerte verarbeiten müssen, verwenden Sie RtlStringCbVPrintfEx.

Weitere Informationen zu den Sicheren Zeichenfolgenfunktionen finden Sie unter Verwenden sicherer Zeichenfolgenfunktionen.

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

Weitere Informationen

RtlStringCbPrintf

RtlStringCbVPrintfEx

RtlStringCchVPrintf