StringCbPrintfA-Funktion (strsafe.h)

Artikel
11/20/2024

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

StringCbPrintf ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCbPrintfA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszFormat,
        ...            
);

Parameter

[out] pszDest

Typ: LPSTR-

Der Zielpuffer, der die formatierte, mit Null beendete Zeichenfolge empfängt, die aus pszFormat und den zugehörigen Argumenten erstellt wurde.

[in] cbDest

Typ: size_t

Die Größe des Zielpuffers in Byte. Dieser Wert muss ausreichend groß sein, um die endgültige formatierte Zeichenfolge sowie das endende NULL-Zeichen aufzunehmen. Die maximale Anzahl zulässiger Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszFormat

Typ: LPCSTR-

Die Formatzeichenfolge. Diese Zeichenfolge muss null beendet werden. 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 SUCCEEDED und FAILED Makros zum Testen des Rückgabewerts dieser Funktion zu verwenden.

Rückgabecode	Beschreibung
S_OK	Es war ausreichend Speicherplatz vorhanden, damit das Ergebnis in pszDest- ohne Abkürzung kopiert werden kann, und der Puffer wird 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 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

Im Vergleich zu den ersetzten Funktionen bietet StringCbPrintf- zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist in vielen Sicherheitsproblemen mit Pufferüberläufen verbunden. StringCbPrintf immer null beendet einen Nicht-Länge-Zielpuffer.

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 StringCbPrintfEx-, wenn Sie die Behandlung von Null-Zeichenfolgenzeigerwerten benötigen.

StringCbPrintf kann in der generischen Form oder in spezifischeren Formen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten.

String-Datentyp	Zeichenfolgenliteral	Funktion
Zeichen-	"string"	StringCbPrintfA-
TCHAR-	TEXT("Zeichenfolge")	StringCbPrintf-
WCHAR-	L"string"	StringCbPrintfW-

Beispiele

Das folgende Beispiel zeigt eine einfache Verwendung von StringCbPrintf-mit vier Argumenten.

int const arraysize = 30;
TCHAR pszDest[arraysize]; 
size_t cbDest = arraysize * sizeof(TCHAR);

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

HRESULT hr = StringCbPrintf(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);

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

Anmerkung

Der strsafe.h-Header definiert StringCbPrintf als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante 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-

StringCbPrintfEx-

StringCbVPrintf-

StringCchPrintf-

Freigeben über