StringCbVPrintfA-Funktion (strsafe.h)

Artikel
03/02/2024

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

StringCbVPrintf ist ein Ersatz für die folgenden Funktionen:

Syntax

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

Parameter

[out] pszDest

Typ: LPTSTR

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

[in] cbDest

Typ: size_t

Die Größe des Zielpuffers in Bytes. Dieser Wert muss ausreichend groß sein, um die endgültige formatierte Zeichenfolge plus das abschließende NULL-Zeichen aufzunehmen. Die maximal zulässige Anzahl von Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszFormat

Typ: LPCTSTR

Die Formatzeichenfolge. Diese Zeichenfolge muss NULL-endend sein. 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 Makros SUCCEEDED und FAILED zu verwenden, um den Rückgabewert dieser Funktion zu testen.

Rückgabecode	BESCHREIBUNG
S_OK	Es war ausreichend Speicherplatz vorhanden, damit das Ergebnis ohne Abschneiden in pszDest kopiert werden konnte, und der Puffer ist NULL-beendet.
STRSAFE_E_INVALID_PARAMETER	Der Wert in cbDest ist entweder 0 oder größer als `STRSAFE_MAX_CCH * sizeof(TCHAR)`.
STRSAFE_E_INSUFFICIENT_BUFFER	Fehler beim Kopiervorgang aufgrund unzureichenden Pufferspeicherplatzes. Der Zielpuffer enthält eine abgeschnittene, mit NULL beendete Version des beabsichtigten Ergebnisses. In Situationen, in denen das Abschneiden akzeptabel ist, kann dies nicht unbedingt als Fehlerbedingung angesehen werden.

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

Hinweise

StringCbVPrintf bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferbehandlung in Ihrem Code. Eine schlechte Pufferbehandlung ist in viele Sicherheitsprobleme verwickelt, die Pufferüberläufe beinhalten. StringCbVPrintf beendet einen Zielpuffer ungleich null.

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

Das Verhalten ist nicht definiert, wenn sich die Zeichenfolgen, auf die von pszDest, pszFormat oder Argumentzeichenfolgen verwiesen wird, überlappen.

Weder pszFormat noch pszDest darf NULL sein. Weitere Informationen finden Sie unter StringCbVPrintfEx , wenn Sie die Behandlung von NULL-Zeichenfolgenzeigerwerten benötigen.

StringCbVPrintf kann in seiner generischen Form oder in seinen spezifischeren Formen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten, wie in der folgenden Tabelle gezeigt.

String-Datentyp	Zeichenfolgenliterale	Funktion
char	„String“	StringCbVPrintfA
TCHAR	TEXT("string")	StringCbVPrintf
WCHAR	L"string"	StringCbVPrintfW

Hinweis

Der strsafe.h-Header definiert StringCbVPrintf 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
Unterstützte Mindestversion (Client)	Windows XP mit SP2 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 mit SP1 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	strsafe.h

Weitere Informationen

Referenz

StringCbPrintf

StringCbVPrintfEx

StringCchVPrintf

Freigeben über