RtlStringCbPrintfA-Funktion (ntstrsafe.h)

Artikel
02/07/2025

Die funktionen RtlStringCbPrintfW und RtlStringCbPrintfA erstellen eine byte-gezählte Textzeichenfolge mit Formatierung, die auf bereitgestellten 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-beendete Zeichenfolge empfängt. Die Funktion erstellt diese Zeichenfolge aus der Formatierungszeichenfolge, die von pszFormat und der Argumentliste der Funktion bereitgestellt wird.

[in] cbDest

Die Größe des Zielpuffers in Byte. Der Puffer muss groß genug sein, um die formatierte Zeichenfolge und das endende Nullzeichen zu enthalten.

Bei Unicode-Zeichenfolgen ist die maximale Anzahl von Bytes NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Bei ANSI-Zeichenfolgen ist die maximale Anzahl von Bytes NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszFormat

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

...

Eine Liste von Argumenten, die von der Funktion basierend auf Formatierungsdirektiven interpretiert werden, 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 cbDest- 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.

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 cbDest- 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

RtlStringCbPrintfW und RtlStringCbPrintfA- sollten anstelle der folgenden Funktionen verwendet werden:

sprintf
swprintf
_snprintf
_snwprintf

Alle diese Funktionen akzeptieren eine Formatzeichenfolge und eine Liste von Argumenten, interpretieren sie und erstellen eine formatierte Zeichenfolge. Die Größe des Zielpuffers in Bytes wird für RtlStringCbPrintfW- und RtlStringCbPrintfA- bereitgestellt, um sicherzustellen, dass sie nicht über das Ende des Puffers schreiben.

Verwenden Sie RtlStringCbPrintfW- zum Behandeln von Unicode-Zeichenfolgen und RtlStringCbPrintfA- zum Behandeln von ANSI-Zeichenfolgen. Das von Ihnen verwendete Formular hängt von Ihren Daten ab, wie in der folgenden Tabelle dargestellt.

Zeichenfolgendatentyp	Zeichenfolgenliteral	Funktion
WCHAR	L"string"	RtlStringCbPrintfW-
Zeichen-	"string"	RtlStringCbPrintfA-

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

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

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

Beispiele

Das folgende Beispiel zeigt eine einfache Verwendung von RtlStringCbPrintfW- mit 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 lautet 1 + 2 = 3". Er ist im Puffer bei pszDestenthalten.

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-	Wenn Zeichenfolgen, die bearbeitet werden, immer im Arbeitsspeicher vorhanden sind, andernfalls PASSIVE_LEVEL

Siehe auch

RtlStringCbPrintfEx

RtlStringCbVPrintf

RtlStringCchPrintf

Freigeben über