StringCbPrintf_lW-Funktion (strsafe.h)

  • Artikel

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.

StringCbPrintf_l ähnelt StringCbPrintf , enthält jedoch einen Parameter für Gebietsschemainformationen.

Syntax

STRSAFEAPI StringCbPrintf_lW(
  [out] STRSAFE_LPWSTR                                  pszDest,
  [in]  size_t                                          cbDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
  [in]  _locale_t                                       locale,
        ...                                             
);

Parameter

[out] pszDest

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

[in] cbDest

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 maximale Anzahl zulässiger Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszFormat

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

[in] locale

Das Gebietsschemaobjekt. Weitere Informationen finden Sie unter _create_locale.

...

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

Rückgabewert

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 cbDest ist entweder 0 oder größer als STRSAFE_MAX_CCH * sizeof(TCHAR).
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.

Hinweise

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. Siehe StringCbPrintf_lEx , wenn Sie die Behandlung von NULL-Zeichenfolgenzeigerwerten benötigen.

Um diese Funktion verwenden zu können, müssen Sie das folgende Makro in Ihrer Headerdatei definieren, bevor Sie StrSafe.h einschließen.

#define STRSAFE_LOCALE_FUNCTIONS

Hinweis

Der strsafe.h-Header definiert StringCbPrintf_l 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 Vista [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile strsafe.h