RtlStringCbPrintfExW-Funktion (ntstrsafe.h)

Artikel
08/07/2023

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

Syntax

NTSTRSAFEDDI RtlStringCbPrintfExW(
  [out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cbDest,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcbRemaining,
  [in]            DWORD            dwFlags,
  [in, optional]  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] 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).

Wenn pszDestNULL ist, muss cbDest null sein.

[out, optional] ppszDestEnd

Wenn der Aufrufer einen Nicht-NULL-Adresszeiger bereitstellt, lädt die Funktion diese Adresse nach Abschluss des Vorgangs mit einem Zeiger auf den resultierenden NULL-Zeichenfolgenabschluss des Zielpuffers.

[out, optional] pcbRemaining

Wenn der Aufrufer einen Nicht-NULL-Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl der nicht verwendeten Bytes, die sich im Puffer befinden, auf die von pszDest verwiesen wird, einschließlich Bytes, die für das beendende NULL-Zeichen verwendet werden.

[in] dwFlags

Ein oder mehrere Flags und optional ein Füllbyte. Die Flags werden wie folgt definiert:

Wert	Bedeutung
STRSAFE_FILL_BEHIND_NULL	Wenn festgelegt und die Funktion erfolgreich ist, wird das niedrige Byte von dwFlags verwendet, um den Teil des Zielpuffers zu füllen, der dem beendenden NULL-Zeichen folgt.
STRSAFE_IGNORE_NULLS	Wenn festgelegt, kann entweder pszDest oder pszSrc oder beides NULL sein. NULLpszSrc-Zeiger werden wie leere Zeichenfolgen (TEXT("")) behandelt, die kopiert werden können. NULLpszDest-Zeiger können keine nicht leeren Zeichenfolgen empfangen.
STRSAFE_FILL_ON_FAILURE	Wenn festgelegt ist und die Funktion fehlschlägt, wird das niedrige Byte von dwFlags verwendet, um den gesamten Zielpuffer zu füllen, und der Puffer ist NULL-beendet. Dieser Vorgang überschreibt alle bereits vorhandenen Pufferinhalte.
STRSAFE_NULL_ON_FAILURE	Wenn festgelegt ist und die Funktion fehlschlägt, wird der Zielpuffer auf eine leere Zeichenfolge (TEXT("")) festgelegt. Dieser Vorgang überschreibt alle bereits vorhandenen Pufferinhalte.
STRSAFE_NO_TRUNCATION	Wenn festgelegt und die Funktion STATUS_BUFFER_OVERFLOW zurückgibt, wird der Inhalt des Zielpuffers nicht geändert.

[in, optional] 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 Liste von Argumenten, die von der Funktion interpretiert werden, basierend auf Formatierungsdirektiven, 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
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. 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.
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: Es wurde ein ungültiges Flag angegeben. Der Wert in cbDest ist größer als die maximale Puffergröße. Der Zielpuffer war bereits voll. Ein NULL-Zeiger war ohne das flag STRSAFE_IGNORE_NULLS vorhanden. Der Zielpufferzeiger war NULL, aber die Puffergröße war nicht 0. Der Zielpufferzeiger war NULL, oder seine Lä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. 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.

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:

Es wurde ein ungültiges Flag angegeben.
Der Wert in cbDest ist größer als die maximale Puffergröße.
Der Zielpuffer war bereits voll.
Ein NULL-Zeiger war ohne das flag STRSAFE_IGNORE_NULLS vorhanden.
Der Zielpufferzeiger war NULL, aber die Puffergröße war nicht 0.
Der Zielpufferzeiger war NULL, oder seine Länge war 0, aber eine Quellzeichenfolge mit ungleicher Länge war vorhanden.

Hinweise

Anstelle der folgenden Funktionen sollten RtlStringCbPrintfExW und RtlStringCbPrintfExA 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 RtlStringCbPrintfExW und RtlStringCbPrintfExA bereitgestellt, um sicherzustellen, dass sie nicht über das Ende des Puffers schreiben.

RtlStringCbPrintfExW und RtlStringCbPrintfExA fügen der Funktionalität von RtlStringCbPrintf hinzu, indem sie einen Zeiger auf das Ende der Zielzeichenfolge zurückgeben, sowie die Anzahl der Bytes, die in dieser Zeichenfolge nicht verwendet werden. Flags können für ein zusätzliches Steuerelement an die Funktion übergeben werden.

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

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

Weder pszFormat 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 pszFormat 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 ab Windows XP mit Service Pack 1 (SP1).
Zielplattform	Desktop
Kopfzeile	ntstrsafe.h (einschließen von Ntstrsafe.h)
Bibliothek	Ntstrsafe.lib
IRQL	PASSIVE_LEVEL

Weitere Informationen

RtlStringCbVPrintfEx

RtlStringCchPrintf

RtlStringCchPrintfEx