StringCchPrintfExA-Funktion (strsafe.h)
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.
StringCchPrintfEx der Funktionalität von StringCchPrintf hinzu, indem ein Zeiger an das Ende der Zielzeichenfolge sowie die Anzahl der Zeichen zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet wurden. Flags können auch an die Funktion übergeben werden, um zusätzliche Steuerelemente zu erhalten.
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 beendete 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, damit die endgültige formatierte Zeichenfolge plus 1 für das endende Nullzeichen berücksichtigt wird. Die maximale Anzahl zulässiger Zeichen ist STRSAFE_MAX_CCH.
[out, optional] ppszDestEnd
Typ: LPTSTR*
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] pcchRemaining
Typ: size_t*
Die Anzahl der nicht verwendeten Zeichen in pszDest, einschließlich des endenden Nullzeichens. Wenn pcchRemainingNULL-ist, wird die Anzahl nicht beibehalten oder zurückgegeben.
[in] dwFlags
Typ: DWORD-
Mindestens einer der folgenden Werte.
[in] pszFormat
Typ: LPCTSTR-
Die Formatzeichenfolge. Diese Zeichenfolge muss null beendet werden. 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 SUCCEEDED und FAILED Makros zum Testen des Rückgabewerts dieser Funktion zu verwenden.
| Rückgabecode | Beschreibung |
|---|---|
|
Es war ausreichend Speicherplatz vorhanden, um das Ergebnis in pszDest ohne Abschneiden zu kopieren, und der Puffer wird null beendet. |
|
Der Wert in cchDest- ist entweder 0 oder größer als STRSAFE_MAX_CCH, oder der Zielpuffer ist bereits voll. |
|
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. |
Beachten Sie, dass diese Funktion einen HRESULT- Wert zurückgibt, im Gegensatz zu den funktionen, die sie ersetzt.
Bemerkungen
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 vielen Sicherheitsproblemen mit Pufferüberläufen verbunden. StringCchPrintfEx immer null-terminates einen Nicht-Länge-Zielpuffer.
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.
StringCchPrintfEx- kann in der generischen Form oder in spezifischeren Formularen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten.
| String-Datentyp | Zeichenfolgenliteral | Funktion |
|---|---|---|
| Zeichen- | "string" | StringCchPrintfExA- |
| TCHAR- | TEXT("Zeichenfolge") | StringCchPrintfEx- |
| WCHAR- | L"string" | StringCchPrintfExW- |
Anmerkung
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
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Windows XP mit SP2 [Desktop-Apps | UWP-Apps] |
| mindestens unterstützte Server- | Windows Server 2003 mit SP1 [Desktop-Apps | UWP-Apps] |
| Zielplattform- | Fenster |
| Header- | strsafe.h |
Siehe auch
Referenz-