RtlStringCbVPrintfExA-Funktion (ntstrsafe.h)

  • Artikel

Die RtlStringCbVPrintfExW und RtlStringCbVPrintfExA Funktionen erstellen eine Zeichenfolge mit Byteanzahl, wobei formatierungsbasierte Formatierungen auf den angegebenen Formatierungsinformationen basieren.

Syntax

NTSTRSAFEDDI RtlStringCbVPrintfExA(
  [out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]            size_t          cbDest,
  [out, optional] NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional] size_t          *pcbRemaining,
  [in]            DWORD           dwFlags,
  [in, optional]  NTSTRSAFE_PCSTR pszFormat,
  [in]            va_list         argList
);

Parameter

[out, optional] pszDest

Ein Zeiger auf einen vom Aufrufer bereitgestellten Puffer, der eine formatierte, null-beendete Zeichenfolge empfängt. Die Funktion erstellt diese Zeichenfolge sowohl aus der Formatierungszeichenfolge, die von pszFormat bereitgestellt wird, als auch aus den Argumenten, die von argList-bereitgestellt werden. Der pszDest Zeiger kann NULL-sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlagsfestgelegt ist.

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

Wenn pszDest-NULL-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-Zeichenfolgenbezeichner des Zielpuffers.

[out, optional] pcbRemaining

Wenn der Aufrufer einen nicht-NULL- Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl nicht verwendeter Bytes, die im Puffer enthalten sind, auf pszDestverwiesen wird, einschließlich Bytes, die für das Beenden des NULL-Zeichens verwendet werden.

[in] dwFlags

Mindestens ein Flag und optional ein Füllbyte. Die Kennzeichen sind wie folgt definiert:

Wert Bedeutung
STRSAFE_FILL_BEHIND_NULL
Wenn festgelegt und die Funktion erfolgreich ausgeführt wird, wird das niedrige Byte von dwFlags verwendet, um den Teil des Zielpuffers zu füllen, der dem endenden Nullzeichen 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. NULL-pszDest Zeiger können keine Zeichenfolgen empfangen.
STRSAFE_FILL_ON_FAILURE
Wenn festgelegt und die Funktion fehlschlägt, wird das niedrige Byte von dwFlags verwendet, um den gesamten Zielpuffer auszufüllen, und der Puffer wird null-beendet. Mit diesem Vorgang werden alle bereits vorhandenen Pufferinhalte überschrieben.
STRSAFE_NULL_ON_FAILURE
Wenn festgelegt und die Funktion fehlschlägt, wird der Zielpuffer auf eine leere Zeichenfolge (TEXT("")) festgelegt. Mit diesem Vorgang werden alle bereits vorhandenen Pufferinhalte überschrieben.
STRSAFE_NO_TRUNCATION
Wenn festgelegt und die Funktion STATUS_BUFFER_OVERFLOW zurückgibt, werden die Inhalte des Zielpuffers nicht geändert.

[in, optional] pszFormat

Ein Zeiger auf eine mit Null beendete Textzeichenfolge, die printf--styled-formatierungsdirektiven enthält. Der pszFormat Zeiger kann NULL-sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlagsfestgelegt ist.

[in] argList

Eine va_list-typed argument list. In der Argumentliste enthaltene Argumente werden mithilfe der Formatierungszeichenfolge interpretiert, die von pszFormatangegeben 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 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. 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 empfangen hat. Weitere Informationen finden Sie im folgenden Absatz.

Die Funktion gibt den STATUS_INVALID_PARAMETER Wert zurück, wenn:

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

Bemerkungen

RtlStringCbVPrintfExW und RtlStringCbVPrintfExA- sollten anstelle der folgenden Funktionen verwendet werden:

  • vsprintf-
  • vswprintf
  • _vsnprintf
  • _vsnwprintf
Alle diese Funktionen akzeptieren eine Formatzeichenfolge zusammen mit einer Reihe von Argumenten in einer va_list-typed-argument list und geben eine formatierte Zeichenfolge zurück. Die Größe des Zielpuffers in Bytes wird für RtlStringCbVPrintfExW- und RtlStringCbVPrintfExA- bereitgestellt, um sicherzustellen, dass sie nicht über das Ende des Puffers schreiben.

RtlStringCbVPrintfExW und RtlStringCbVPrintfExA der Funktionalität von RtlStringCbVPrintf hinzufügen, indem ein Zeiger an das Ende der Zielzeichenfolge sowie die Anzahl der in dieser Zeichenfolge nicht verwendeten Bytes zurückgegeben wird. Flags können für zusätzliche Steuerelemente an die Funktion übergeben werden.

Weitere Informationen zu va_list-typed-argument lists finden Sie in der Microsoft Windows SDK-Dokumentation.

Verwenden Sie RtlStringCbVPrintfExW- zum Behandeln von Unicode-Zeichenfolgen und RtlStringCbVPrintfExA- 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" RtlStringCbVPrintfExW-
Zeichen- "string" RtlStringCbVPrintfExA
 

Wenn pszDest und pszFormat auf überlappende Zeichenfolgen zeigen oder 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 beides NULL-sein. Wenn pszDest-NULL-ist, muss pszFormat- entweder NULL- sein oder auf eine leere Zeichenfolge zeigen.

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 in Windows XP mit Service Pack 1 (SP1) und höheren Versionen von Windows.
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

RtlStringCchVPrintfEx