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

StringCchPrintfEx fügt der Funktionalität von StringCchPrintf hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl von Zeichen zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet werden. Flags können auch zur zusätzlichen Steuerung an die Funktion übergeben werden.

StringCchPrintfEx ist ein Ersatz für die folgenden Funktionen:

Syntax

STRSAFEAPI StringCchPrintfExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags,
  [in]            STRSAFE_LPCSTR pszFormat,
                  ...            
);

Parameter

[out] pszDest

Typ: LPTSTR

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

[in] cchDest

Typ: size_t

Die Größe des Zielpuffers in Zeichen. Dieser Wert muss ausreichend groß sein, um die endgültige formatierte Zeichenfolge plus 1 aufzunehmen, um das abschließende NULL-Zeichen zu berücksichtigen. Die maximale Anzahl zulässiger Zeichen ist STRSAFE_MAX_CCH.

[out, optional] ppszDestEnd

Typ: LPTSTR*

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

Typ: size_t*

Die Anzahl nicht verwendeter Zeichen in pszDest, einschließlich des abschließenden NULL-Zeichens. Wenn pcchRemainingNULL ist, wird die Anzahl nicht beibehalten oder zurückgegeben.

[in] dwFlags

Art: DWORD

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

Typ: LPCTSTR

Die Formatzeichenfolge. Diese Zeichenfolge muss NULL-endend sein. Weitere Informationen finden Sie unter Formatspezifikationssyntax.

...

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

Rückgabewert

Typ: HRESULT

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 ausreichend Speicherplatz vorhanden, damit das Ergebnis ohne Abschneiden in pszDest kopiert werden konnte, und der Puffer ist NULL-beendet.
STRSAFE_E_INVALID_PARAMETER
 Der Wert in cchDest ist entweder 0 oder größer als STRSAFE_MAX_CCH, oder der Zielpuffer ist bereits voll.
STRSAFE_E_INSUFFICIENT_BUFFER
 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.
 

Beachten Sie, dass diese Funktion im Gegensatz zu den Funktionen, die sie ersetzt, einen HRESULT-Wert zurückgibt.

Hinweise

Im Vergleich zu den ersetzten Funktionen bietet StringCchPrintfEx zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist in viele Sicherheitsprobleme verwickelt, die Pufferüberläufe beinhalten. StringCchPrintfEx beendet einen Zielpuffer ungleich null.

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.

StringCchPrintfEx kann in seiner generischen Form oder in seinen spezifischeren Formen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten.

String-Datentyp Zeichenfolgenliterale Funktion
char „String“ StringCchPrintfExA
TCHAR TEXT("string") StringCchPrintfEx
WCHAR L"string" StringCchPrintfExW
 

Hinweis

Der strsafe.h-Header definiert StringCchPrintfEx 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

   
Unterstützte Mindestversion (Client) Windows XP mit SP2 [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 mit SP1 [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile strsafe.h

Weitere Informationen

Referenz

StringCbPrintfEx

StringCchPrintf

StringCchVPrintfEx