StringCbPrintf_lExA 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_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, 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).

[out] ppszDestEnd

Die Adresse eines Zeigers bis zum Ende pszDest. Wenn ppszDestEnd- nichtNULL- ist und alle Daten in den Zielpuffer kopiert werden, verweist dies auf das endende NULL-Zeichen am Ende der Zeichenfolge.

[out, optional] pcbRemaining

Die Anzahl der nicht verwendeten Bytes in pszDest, einschließlich derjenigen, die für das endende Nullzeichen verwendet werden. Wenn pcbRemainingNULList, 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 pszDest nach dem endenden NULL-Zeichen auszufü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 auszufüllen, und der Puffer wird null beendet. Bei einem STRSAFE_E_INSUFFICIENT_BUFFER Fehler wird jede abgeschnittene Zeichenfolge, die zurückgegeben wird, überschrieben.
STRSAFE_NULL_ON_FAILURE 0x00000800	Wenn die Funktion fehlschlägt, wird pszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Bei einem STRSAFE_E_INSUFFICIENT_BUFFER Fehler wird jede abgeschnittene Zeichenfolge überschrieben.
STRSAFE_NO_TRUNCATION 0x00001000	Wenn die Funktion fehlschlägt, wird pszDest- wie bei STRSAFE_NULL_ON_FAILUREauf eine leere Zeichenfolge (TEXT("")) festgelegt. Bei einem STRSAFE_E_INSUFFICIENT_BUFFER Fehler wird jede abgeschnittene Zeichenfolge überschrieben.

[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)`, oder der Zielpuffer ist bereits voll.
STRSAFE_E_INSUFFICIENT_BUFFER	Fehler beim Kopiervorgang aufgrund unzureichender Pufferspeicher. Abhängig vom Wert von dwFlagskann der Zielpuffer eine abgeschnittene, null-beendete Version des beabsichtigten Ergebnisses enthalten. 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 NULL- sein, es sei denn, das STRSAFE_IGNORE_NULLS Flag ist angegeben, in diesem Fall kann beide NULL-sein. Ein Fehler aufgrund unzureichender Leerzeichen kann jedoch weiterhin 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

Anmerkung

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
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