StrFormatByteSizeA-Funktion (shlwapi.h)
Wandelt einen numerischen Wert in eine Zeichenfolge um, die je nach Größe als Größenwert in Byte, Kilobyte, Megabyte oder Gigabyte ausgedrückt wird. Unterscheidet sich von StrFormatByteSizeW- in einem Parametertyp.
Syntax
PSTR StrFormatByteSizeA(
DWORD dw,
[out] PSTR pszBuf,
UINT cchBuf
);
Parameter
dw
Typ: DWORD-
Der zu konvertierende numerische Wert.
[out] pszBuf
Typ: PSTR-
Ein Zeiger auf einen Puffer, der die konvertierte Zeichenfolge empfängt.
cchBuf
Typ: UINT-
Die Größe des Puffers, auf den pszBufin Zeichen verweist.
Rückgabewert
Typ: PSTR-
Gibt einen Zeiger auf die konvertierte Zeichenfolge oder NULL- zurück, wenn die Konvertierung fehlschlägt.
Bemerkungen
Der erste Parameter dieser Funktion weist einen anderen Typ für die ANSI- und Unicode-Versionen auf. Wenn ihr numerischer Wert ein DWORD-ist, können Sie StrFormatByteSize- mit Textmakros für beide Fälle verwenden. Der Compiler wandelt den numerischen Wert in einen LONGLONG- für den Unicode-Fall um. Wenn ihr numerischer Wert ein LONGLONG-ist, sollten Sie StrFormatByteSizeW- explizit verwenden.
In Windows 10 wird die Größe in Basis 10 und nicht in Basis 2 gemeldet. Beispielsweise beträgt 1 KB 1000 Bytes und nicht 1024.
In der folgenden Tabelle wird veranschaulicht, wie diese Funktion einen numerischen Wert in eine Textzeichenfolge konvertiert.
| Numerischer Wert | Textfolge |
|---|---|
| 532 | 532 Bytes |
| 1340 | 1.30 KB |
| 23506 | 22,9 KB |
| 2400016 | 2,28 MB |
| 2400000000 | 2,23 GB |
Anmerkung
Der Header "shlwapi.h" definiert StrFormatByteSize 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 2000 Professional, Windows XP [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | shlwapi.h |
| Library | Shlwapi.lib |
| DLL- | Shlwapi.dll (Version 4.71 oder höher) |