StringCchVPrintfA-Funktion (strsafe.h)

Artikel
11/20/2024

Schreibt formatierte Daten mithilfe eines Zeigers auf eine Liste von Argumenten in die angegebene Zeichenfolge. Die Größe des Zielpuffers wird der Funktion bereitgestellt, um sicherzustellen, dass er nicht über das Ende dieses Puffers schreibt.

StringCchVPrintf ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCchVPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_LPCSTR pszFormat,
  [in]  va_list        argList
);

Parameter

[out] pszDest

Typ: LPTSTR-

Der Zielpuffer, der die formatierte, null-beendete Zeichenfolge empfängt, die aus pszFormat und argList-erstellt wird.

[in] cchDest

Typ: size_t

Die Größe des Zielpuffers in Zeichen. Dieser Wert muss ausreichend groß sein, damit die endgültige formatierte Zeichenfolge plus 1 für das endende Nullzeichen berücksichtigt wird. Die maximale Anzahl zulässiger Zeichen ist STRSAFE_MAX_CCH.

[in] pszFormat

Typ: LPCTSTR-

Die Formatzeichenfolge. Diese Zeichenfolge muss null beendet werden. Weitere Informationen finden Sie unter Formatspezifikationssyntax.

[in] argList

Typ: va_list

Die Argumente, die in die pszFormat- Zeichenfolge eingefügt werden sollen.

Rückgabewert

Typ: HRESULT-

Diese Funktion kann einen der folgenden Werte zurückgeben. Es wird dringend empfohlen, die SUCCEEDED und FAILED Makros zum Testen des Rückgabewerts dieser Funktion zu verwenden.

Rückgabecode	Beschreibung
S_OK	Es war ausreichend Speicherplatz vorhanden, um das Ergebnis in pszDest ohne Abschneiden zu kopieren, und der Puffer wird null beendet.
STRSAFE_E_INVALID_PARAMETER	Der Wert in cchDest- ist entweder 0 oder größer als STRSAFE_MAX_CCH.
STRSAFE_E_INSUFFICIENT_BUFFER	Fehler beim Kopiervorgang aufgrund unzureichender Pufferspeicher. Der Zielpuffer enthält eine abgeschnittene, null-beendete Version des beabsichtigten Ergebnisses. In Situationen, in denen abgeschnitten werden kann, kann dies möglicherweise nicht unbedingt als Fehlerbedingung angesehen werden.

Beachten Sie, dass diese Funktion einen HRESULT- Wert zurückgibt, im Gegensatz zu den funktionen, die sie ersetzt.

Bemerkungen

StringCchVPrintf bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist in vielen Sicherheitsproblemen mit Pufferüberläufen verbunden. StringCchVPrintf immer null-terminates einen Nicht-Länge-Zielpuffer.

Weitere Informationen zu va_lists finden Sie in den in Stdarg.h definierten Konventionen.

Das Verhalten ist nicht definiert, wenn die Zeichenfolgen, auf die durch pszDest, pszFormat-oder argumentbasierte Zeichenfolgen verwiesen werden, überlappen.

Weder pszFormat noch pszDest sollte NULLsein. Weitere Informationen finden Sie unter StringCchVPrintfEx-, wenn Sie die Behandlung von Null-Zeichenfolgenzeigerwerten benötigen.

StringCchVPrintf- kann in der generischen Form oder in spezifischeren Formen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten, wie in der folgenden Tabelle dargestellt.

String-Datentyp	Zeichenfolgenliteral	Funktion
Zeichen-	"string"	StringCchVPrintfA-
TCHAR-	TEXT("Zeichenfolge")	StringCchVPrintf-
WCHAR-	L"string"	StringCchVPrintfW-

Anmerkung

Der strsafe.h-Header definiert StringCchVPrintf als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows XP mit SP2 [Desktop-Apps \| UWP-Apps]
mindestens unterstützte Server-	Windows Server 2003 mit SP1 [Desktop-Apps \| UWP-Apps]
Zielplattform-	Fenster
Header-	strsafe.h

Siehe auch

Referenz-

StringCbVPrintf-

StringCchPrintf-

StringCchVPrintfEx

Freigeben über