RtlStringCbPrintfExA-Funktion (ntstrsafe.h)

Die RtlStringCbPrintfExW und RtlStringCbPrintfExA Funktionen erstellen eine byte-gezählte Textzeichenfolge mit Formatierung, die auf bereitgestellten Formatierungsinformationen basiert.

Syntax

NTSTRSAFEDDI RtlStringCbPrintfExA(
  [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,
                  ...             
);

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] 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:

[in, optional] pszFormat

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

...

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.

Bemerkungen

RtlStringCbPrintfExW und RtlStringCbPrintfExA- sollten anstelle der folgenden Funktionen verwendet werden:

• sprintf
• swprintf
• _snprintf
• _snwprintf

RtlStringCbPrintfExW und RtlStringCbPrintfExA der Funktionalität von RtlStringCbPrintf 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.

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

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

Siehe auch

RtlStringCbVPrintfEx

RtlStringCchPrintf

RtlStringCchPrintfEx