StringCbPrintf_lA-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_l ähnelt StringCbPrintf-, enthält jedoch einen Parameter für Gebietsschemainformationen.

Syntax

STRSAFEAPI StringCbPrintf_lA(
  [out] STRSAFE_LPSTR                                  pszDest,
  [in]  size_t                                         cbDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
  [in]  _locale_t                                      locale,
        ...                                            
);

Parameter

[out] pszDest

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

[in] cbDest

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

Die Formatzeichenfolge. Diese Zeichenfolge muss null beendet werden. 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 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.

Bemerkungen

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. Lesen Sie 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

Anmerkung

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 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 Vista [Desktop-Apps \| UWP-Apps]
mindestens unterstützte Server-	Windows Server 2008 [Desktop-Apps \| UWP-Apps]
Zielplattform-	Fenster
Header-	strsafe.h

Freigeben über