StringCchPrintfA-Funktion (strsafe.h)

Artikel
08/26/2023

Schreibt formatierte Daten 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.

StringCchPrintf ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCchPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_LPCSTR pszFormat,
        ...            
);

Parameter

[out] pszDest

Typ: LPTSTR

Der Zielpuffer, der die formatierte null-beendete Zeichenfolge empfängt, die aus pszFormat erstellt wurde, und die zugehörigen Argumente.

[in] cchDest

Typ: size_t

Die Größe des Zielpuffers in Zeichen. Dieser Wert muss ausreichend groß sein, um die endgültige formatierte Zeichenfolge plus 1 aufzunehmen, um das beendende NULL-Zeichen zu berücksichtigen. Die maximal zulässige Anzahl von Zeichen ist STRSAFE_MAX_CCH.

[in] pszFormat

Typ: LPCTSTR

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

...

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 genügend Speicherplatz vorhanden, um das Ergebnis ohne Abschneiden in pszDest zu kopieren, und der Puffer ist 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 des unzureichenden Pufferspeichers. Der Zielpuffer enthält eine abgeschnittene, NULL-beendete Version des beabsichtigten Ergebnisses. In Situationen, in denen abgeschnitten werden kann, 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

Im Vergleich zu den ersetzten Funktionen bietet StringCchPrintf zusätzliche Verarbeitung für die ordnungsgemäße Pufferbehandlung im Code. Eine schlechte Pufferbehandlung ist mit vielen Sicherheitsproblemen verbunden, die Pufferüberläufe umfassen. StringCchPrintf beendet immer null einen Zielpuffer mit ungleicher Länge.

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

Weder pszFormat noch pszDest sollte NULL sein. Wenn Sie die Behandlung von NULL-Zeichenfolgenzeigerwerten benötigen, finden Sie unter StringCchPrintfEx .

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

String-Datentyp	Zeichenfolgenliterale	Funktion
char	„String“	StringCchPrintfA
TCHAR	TEXT("string")	StringCchPrintf
WCHAR	L"Zeichenfolge"	StringCchPrintfW

Beispiele

Das folgende Beispiel zeigt eine einfache Verwendung von StringCchPrintf unter Verwendung von vier Argumenten.

TCHAR pszDest[30]; 
size_t cchDest = 30;

LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");

HRESULT hr = StringCchPrintf(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);

// The resultant string at pszDest is "The answer is 1 + 2 = 3."

Hinweis

Der strsafe.h-Header definiert StringCchPrintf 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 nicht codierungsneutralem Code 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

StringCchPrintfEx

StringCchVPrintf

Freigeben über