StringCbPrintf_lExW-Funktion (strsafe.h)
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_lEx ähnelt StringCbPrintfEx , enthält jedoch einen Parameter für Gebietsschemainformationen.
Syntax
STRSAFEAPI StringCbPrintf_lExW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cbDest,
[out] STRSAFE_LPWSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags,
[in] _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
[in] _locale_t locale,
...
);
Parameter
[out] pszDest
Der Zielpuffer, der die formatierte, mit NULL endende Zeichenfolge empfängt, die aus pszFormat und den zugehörigen Argumenten erstellt wurde.
[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 maximal zulässige Anzahl von Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR)
.
[out] ppszDestEnd
Die Adresse eines Zeigers auf das Ende von pszDest. Wenn ppszDestEnd ungleich NULL ist und alle Daten in den Zielpuffer kopiert werden, zeigt dies auf das endende NULL-Zeichen am Ende der Zeichenfolge.
[out, optional] pcbRemaining
Die Anzahl nicht verwendeter Bytes in pszDest, einschließlich der bytes, die für das beendende NULL-Zeichen verwendet werden. Wenn pcbRemainingNULL ist, wird die Anzahl nicht beibehalten oder zurückgegeben.
[in] dwFlags
Mindestens einer der folgenden Werte:
[in] pszFormat
Die Formatzeichenfolge. Diese Zeichenfolge muss NULL-endend 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 |
---|---|
|
Es war ausreichend Speicherplatz vorhanden, damit das Ergebnis ohne Abschneiden in pszDest kopiert werden konnte, und der Puffer ist NULL-beendet. |
|
Der Wert in cbDest ist entweder 0 oder größer als STRSAFE_MAX_CCH * sizeof(TCHAR) , oder der Zielpuffer ist bereits voll.
|
|
Fehler beim Kopiervorgang aufgrund unzureichenden Pufferspeicherplatzes. Abhängig vom Wert von dwFlags kann der Zielpuffer eine abgeschnittene version des beabsichtigten Ergebnisses enthalten. In Situationen, in denen das Abschneiden akzeptabel ist, kann dies nicht unbedingt als Fehlerbedingung angesehen werden. |
Hinweise
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, es sei denn, das flag STRSAFE_IGNORE_NULLS ist angegeben. In diesem Fall können beide NULL sein. Ein Fehler aufgrund unzureichenden Speicherplatzes kann jedoch trotzdem zurückgegeben werden, obwohl NULL-Werte ignoriert werden.
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_lEx 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 Vista [Desktop-Apps | UWP-Apps] |
Unterstützte Mindestversion (Server) | Windows Server 2008 [Desktop-Apps | UWP-Apps] |
Zielplattform | Windows |
Kopfzeile | strsafe.h |