StrFormatByteSizeA-Funktion (shlwapi.h)

  • Artikel

Konvertiert einen numerischen Wert in eine Zeichenfolge, die die Zahl darstellt, die je nach Größe als Größenwert in Bytes, 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

Art: 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 pszBuf in Zeichen verweist.

Rückgabewert

Typ: PSTR

Gibt einen Zeiger auf die konvertierte Zeichenfolge oder NULL zurück, wenn die Konvertierung fehlschlägt.

Hinweise

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 für beide Fälle mit Textmakros verwenden. Der Compiler wandelt den numerischen Wert für den Unicode-Fall in einen LONGLONG-Wert um. Wenn Ihr numerischer Wert longlong ist, sollten Sie StrFormatByteSizeW explizit verwenden.

In Windows 10 wird die Größe in Basis 10 und nicht in Basis 2 gemeldet. Beispielsweise sind 1 KB 1000 Bytes statt 1024.

Die folgende Tabelle veranschaulicht, wie diese Funktion einen numerischen Wert in eine Textzeichenfolge konvertiert.

Numerischer Wert Textzeichenfolge
532 532 Bytes
1340 1,30 KB
23506 22,9 KB
2400016 2,28 MB
2400000000 2,23 GB
 

Hinweis

Der shlwapi.h-Header 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

   
Unterstützte Mindestversion (Client) Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shlwapi.h
Bibliothek Shlwapi.lib
DLL Shlwapi.dll (Version 4.71 oder höher)

Weitere Informationen

StrFormatByteSize64

StrFormatByteSizeEx

StrFormatByteSizeW