StringCbPrintf_lExA-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_lExA(
  [out]           STRSAFE_LPSTR                                  pszDest,
  [in]            size_t                                         cbDest,
  [out]           STRSAFE_LPSTR                                  *ppszDestEnd,
  [out, optional] size_t                                         *pcbRemaining,
  [in]            DWORD                                          dwFlags,
  [in]            _Printf_format_string_params_(2)STRSAFE_LPCSTR 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).

[out] ppszDestEnd

Die Adresse eines Zeigers auf das Ende von pszDest. Wenn ppszDestEnd nicht NULL ist und alle Daten in den Zielpuffer kopiert werden, zeigt dies auf das beendende NULL-Zeichen am Ende der Zeichenfolge.

[out, optional] pcbRemaining

Die Anzahl der nicht verwendeten 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:

Wert	Bedeutung
STRSAFE_FILL_BEHIND_NULL 0x00000200	Wenn die Funktion erfolgreich ist, wird das niedrige Byte von dwFlags (0) verwendet, um den nicht initialisierten Teil von pszDest nach dem beendenden NULL-Zeichen zu füllen.
STRSAFE_IGNORE_NULLS 0x00000100	Behandeln Sie NULL-Zeichenfolgenzeiger wie leere Zeichenfolgen (TEXT("").).
STRSAFE_FILL_ON_FAILURE 0x00000400	Wenn die Funktion fehlschlägt, wird das niedrige Byte von dwFlags (0) verwendet, um den gesamten pszDest-Puffer zu füllen, und der Puffer ist NULL-beendet. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede zurückgegebene abgeschnittene Zeichenfolge überschrieben.
STRSAFE_NULL_ON_FAILURE 0x00000800	Wenn die Funktion fehlschlägt, wird pszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede abgeschnittene Zeichenfolge überschrieben.
STRSAFE_NO_TRUNCATION 0x00001000	Wenn die Funktion fehlschlägt, wird wie bei STRSAFE_NULL_ON_FAILUREpszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede abgeschnittene Zeichenfolge überschrieben.

[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), oder der Zielpuffer ist bereits voll.
STRSAFE_E_INSUFFICIENT_BUFFER	Fehler beim Kopiervorgang aufgrund des unzureichenden Pufferspeichers. Abhängig vom Wert von dwFlags kann der Zielpuffer eine abgeschnittene, null-beendete Version des beabsichtigten Ergebnisses enthalten. 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, 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 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

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