Click here to Skip to main content
Click here to Skip to main content

Format File Sizes in Human Readable Format

, 30 Nov 2002
Rate this:
Please Sign up or sign in to vote.
An article on formatting of file sizes in a human readable format.
<!-- Download Links --> <!-- Article image -->

Format Size Test Application

<!-- Add the rest of your HTML here -->

Introduction

While working on a project I needed to display the sizes in a human readable format, i.e. 1KB, 1.20MB, and so on. Although I am referring to this functionality here as file size formatting, the same code can be used to format any value that represents a number of bytes. Due to the simplicity of the problem, I decided that this would be a perfect topic for my first article!

Requirements

  • Using B, KB, MB, GB to display the sizes in a logical format.
  • Using commas as thousands separator

An example would be: 1,023 KB (if size = 1023 * 1024 bytes)

Using the code

The code is composed of two functions. The first is InsertSeparators() which is used internally from within the main function to add the thousands separator. The second and main function is FormatSize() which is used to do the all the required formatting.

Following is the code for InsertSeparators(). This function is placed in an unnamed namespace in order to make it a local function.

namespace
{
  /**
   * Converts a positive number to a string while inserting separators.
   *
   * @param dwNumber A positive number to add thousands separator for
   *
   * @return The number with thousand separators as a CString
   */
  CString InsertSeparator (DWORD dwNumber)
  {
    CString str;

    str.Format("%u", dwNumber);

    for (int i = str.GetLength()-3; i > 0; i -= 3)
    {
      str.Insert(i, ",");
    }

    return (str);
  }
}

Following is the code for the FormatSize() function:

/**
 * Converts a filesize to a human readable format.
 *
 * This involves the use of K and M as multipliers.  Hence,
 * strings are formatted as 1024 -> 1KB, 1023 -> 1,023 B,
 * and so on.
 *
 * @param dwFileSize File size to be formatted.
 *
 * @return The formatted filesize as a CString
 */
CString FormatSize (DWORD dwFileSize)
{
  static const DWORD dwKB = 1024;          // Kilobyte
  static const DWORD dwMB = 1024 * dwKB;   // Megabyte
  static const DWORD dwGB = 1024 * dwMB;   // Gigabyte

  DWORD dwNumber, dwRemainder;
  CString strNumber;

  if (dwFileSize < dwKB)
  {
    strNumber = InsertSeparator(dwFileSize) + " B";
  } 
  else
  {
    if (dwFileSize < dwMB)
    {
      dwNumber = dwFileSize / dwKB;
      dwRemainder = (dwFileSize * 100 / dwKB) % 100;

      strNumber.Format("%s.%02d KB", (LPCSTR)InsertSeparator(dwNumber), dwRemainder);
    }
    else
    {
      if (dwFileSize < dwGB)
      {
        dwNumber = dwFileSize / dwMB;
        dwRemainder = (dwFileSize * 100 / dwMB) % 100;
        strNumber.Format("%s.%02d MB", InsertSeparator(dwNumber), dwRemainder);
      }
      else
      {
        if (dwFileSize >= dwGB)
        {
          dwNumber = dwFileSize / dwGB;
          dwRemainder = (dwFileSize * 100 / dwGB) % 100;
          strNumber.Format("%s.%02d GB", InsertSeparator(dwNumber), dwRemainder);
        }
      }
    }
  }

  // Display decimal points only if needed
  // another alternative to this approach is to check before calling str.Format, and 
  // have separate cases depending on whether dwRemainder == 0 or not.
  strNumber.Replace(".00", "");

  return strNumber;
}

Future Improvements

The following are planned future improvements for the next versions of the article:

  • Make the thousands separator and the decimal point dependent on Control Panel settings.
  • Unicode Support

History

01-DEC-2002First version

Edit History

2 Dec 2002 - Initial Edit

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

Victor Boctor
Web Developer
United States United States
Victor Boctor is a Windows/Linux professional developer. He has worked in the fields of Email Servers, Automatic Test Equipment, Telecommunications, and Embroidery software. He developed software using C#, C++, MFC, Win32, PHP, Cold Fusion, HTML, XHTML, and SQL.

Comments and Discussions

 
GeneralGeneralize Solution PinmemberMina Victor4-Jan-10 15:14 
GeneralEmbroidery Pinmembermmhafez17-Sep-03 7:54 
GeneralAlso see GetNumberFormat() PinmemberRavi Bhavnani1-Dec-02 7:35 
GeneralAnother way Pinmemberdabs1-Dec-02 3:16 
GeneralRe: Another way PinmemberVictor Boctor1-Dec-02 3:31 
GeneralRe: Another way PinmemberAndreas Saurwein4-Dec-02 1:24 
GeneralNice, but... PinmemberAnders Molin1-Dec-02 2:02 
GeneralRe: Nice, but... PinmemberVictor Boctor1-Dec-02 2:11 
GeneralRe: Nice, but... PinmemberPaolo Messina1-Dec-02 12:55 
GeneralRe: Nice, but... PinmemberVictor Boctor1-Dec-02 16:25 
GeneralRe: Nice, but... PinmemberDalle1-Dec-02 22:34 
GeneralRe: Nice, but... PinmemberPaolo Messina2-Dec-02 7:23 
GeneralRe: Nice, but... PinmemberVictor Boctor2-Dec-02 10:20 
QuestionToo many numbers? PinmemberDalle1-Dec-02 2:01 
AnswerRe: Too many numbers? PinmemberVictor Boctor1-Dec-02 3:18 
GeneralRe: Too many numbers? PinmemberKarstenK2-Dec-02 5:17 
GeneralRe: Too many numbers? PinmemberCompMan442-Sep-08 13:35 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.1411023.1 | Last Updated 1 Dec 2002
Article Copyright 2002 by Victor Boctor
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid