RtlStringCchPrintfExA-Funktion (ntstrsafe.h)

Artikel
07/16/2024

Die funktionen RtlStringCchPrintfExW und RtlStringCchPrintfExA erstellen eine Zeichenfolge mit Zeichenanzahl, wobei formatierungen, die auf den bereitgestellten Formatierungsinformationen basieren.

Syntax

NTSTRSAFEDDI RtlStringCchPrintfExA(
  [out, optional] NTSTRSAFE_PSTR  pszDest,
  [in]            size_t          cchDest,
  [out, optional] NTSTRSAFE_PSTR  *ppszDestEnd,
  [out, optional] size_t          *pcchRemaining,
  [in]            DWORD           dwFlags,
  [in]            NTSTRSAFE_PCSTR pszFormat,
                  ...             
);

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 aus der Formatierungszeichenfolge, die von pszFormat und der Argumentliste der Funktion bereitgestellt wird. Der pszDest Zeiger kann NULL-sein, aber nur, wenn STRSAFE_IGNORE_NULLS in dwFlagsfestgelegt ist.

[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. Wenn pszDest-NULL-ist, muss cchDest- 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 Zeichenfolgenbeschriftungsterminator.

[out, optional] pcchRemaining

Wenn der Aufrufer einen nicht-NULL- Adresszeiger bereitstellt, lädt die Funktion die Adresse mit der Anzahl nicht verwendeter Zeichen im Puffer, auf die durch pszDestverwiesen wird, einschließlich des endenden NULL-Zeichens.

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

...

Eine optionale 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 NTSTATUS--Werte finden Sie unter Using NTSTATUS Values.

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

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

RtlStringCchPrintfExW und RtlStringCchPrintfExA- 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. RtlStringCchPrintfExW und RtlStringCchPrintfExA die Größe des Zielpuffers akzeptieren, um sicherzustellen, dass sie nicht über das Ende dieses Puffers schreiben.

RtlStringCchPrintfExW und RtlStringCchPrintfExA der Funktionalität von RtlStringCchPrintf durch Zurückgeben eines Zeigers an das Ende der Zielzeichenfolge sowie die Anzahl der zeichen, die in dieser Zeichenfolge nicht verwendet wurden. Flags können für zusätzliche Steuerelemente an die Funktion übergeben werden.

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

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

Weder pszSrc 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 pszSrc 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

RtlStringCchPrintf

RtlStringCchVPrintfEx

Freigeben über