RtlStringCchPrintfW-Funktion (ntstrsafe.h)

Die RtlStringCchPrintfW- und RtlStringCchPrintfA--Funktionen erstellen eine Zeichenfolge mit Zeichenanzahl und formatierung, die auf den angegebenen Formatierungsinformationen basiert.

Syntax

NTSTRSAFEDDI RtlStringCchPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
        ...              
);

Parameter

[out] pszDest

Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine formatierte, null-beendete Zeichenfolge empfängt. Die Funktion erstellt diese Zeichenfolge aus der Formatierungszeichenfolge, die von pszFormat und der Argumentliste der Funktion bereitgestellt wird.

[in] cchDest

Die Größe des Zielpuffers in Zeichen. Der Puffer muss groß genug sein, um die formatierte Zeichenfolge und das endende Nullzeichen zu enthalten. Die maximale Anzahl zulässiger Zeichen ist NTSTRSAFE_MAX_CCH.

[in] pszFormat

Ein Zeiger auf eine mit Null beendete Textzeichenfolge, die printf--styled Formatierungsdirektivenenthält.

...

Eine 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
STATUS_SUCCESS	Dieser Erfolg Status bedeutet, dass Quelldaten vorhanden waren, die Zeichenfolge ohne Abkürzung 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 abgeschnittene Version der Ausgabezeichenfolge.
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: Der Wert in cchDest- ist größer als die maximale Puffergröße. Der Zielpuffer war bereits voll. Ein NULL- Zeiger vorhanden war. Die Länge des Zielpuffers war null, aber eine Zeichenfolge mit nicht nuller Länge war vorhanden.

Bemerkungen

RtlStringCchPrintfW und RtlStringCchPrintfA sollten anstelle der folgenden Funktionen verwendet werden:

• sprintf
• swprintf
• _snprintf
• _snwprintf

Alle diese Funktionen akzeptieren eine Formatzeichenfolge und eine Liste von Argumenten und geben eine formatierte Zeichenfolge zurück. RtlStringCchPrintfW und RtlStringCchPrintfA die Größe des Zielpuffers in Zeichen akzeptieren, um sicherzustellen, dass die Funktionen nicht über das Ende des Puffers schreiben.

Verwenden Sie RtlStringCchPrintfW- zum Behandeln von Unicode-Zeichenfolgen und RtlStringCchPrintfA- zum Behandeln von ANSI-Zeichenfolgen. Das von Ihnen verwendete Formular hängt von Ihren Daten ab.

Zeichenfolgendatentyp	Zeichenfolgenliteral	Funktion
WCHAR	L"string"	RtlStringCchPrintfW
Zeichen-	"string"	RtlStringCchPrintfA

 

Wenn pszDest und pszFormat auf überlappende Zeichenfolgen zeigen oder argumentbasierte Zeichenfolgen überlappen, ist das Verhalten der Funktion nicht definiert.

Weder pszFormat noch pszDest kann NULLsein. Wenn Sie NULL- Zeichenfolgenzeigerwerte behandeln müssen, verwenden Sie RtlStringCchPrintfEx.

Beispiele

Das folgende Beispiel zeigt eine einfache Verwendung von RtlStringCchPrintfW- mit vier Argumenten.

WCHAR pszDest[30]; 
size_t cchDest = 30;

LPCWSTR pszFormat = L"%s %d + %d = %d.";
WCHAR* pszTxt = L"The answer is";

NTSTATUS status = 
    RtlStringCchPrintfW(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);

Die resultierende Zeichenfolge lautet "Die Antwort lautet 1 + 2 = 3". Er ist im Puffer bei pszDestenthalten.

Weitere Informationen zu den sicheren Zeichenfolgenfunktionen finden Sie unter Verwenden von Funktionen für sichere Zeichenfolgen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Verfügbar ab Windows XP mit Service Pack 1 (SP1).
Zielplattform-	Desktop
Header-	ntstrsafe.h (include Ntstrsafe.h)
Library	Ntstrsafe.lib
IRQL-	PASSIVE_LEVEL

Siehe auch

RtlStringCbPrintf

RtlStringCchPrintfEx

RtlStringCchVPrintf