StrFormatByteSize64A function (shlwapi.h)

Converts a numeric value into a string that represents the number expressed as a size value in bytes, kilobytes, megabytes, or gigabytes, depending on the size.

Syntax

PSTR StrFormatByteSize64A(
        LONGLONG qdw,
  [out] PSTR     pszBuf,
        UINT     cchBuf
);

Parameters

qdw

Type: LONGLONG

The numeric value to be converted.

[out] pszBuf

Type: PSTR

A pointer to a buffer that, when this function returns successfully, receives the converted number.

cchBuf

Type: UINT

The size of the buffer pointed to by pszBuf, in characters.

Return value

Type: PSTR

Returns a pointer to the converted string, or NULL if the conversion fails.

Remarks

StrFormatByteSize64 can be used for either ANSI or Unicode characters. However, while StrFormatByteSize64A can be called directly, StrFormatByteSize64W is not defined. When StrFormatByteSize64 is called with a Unicode value, StrFormatByteSizeW is used.

In Windows 10, size is reported in base 10 rather than base 2. For example, 1 KB is 1000 bytes rather than 1024.

The following table illustrates how this function converts a numeric value into a text string.

Requirements

See also

StrFormatByteSizeA

StrFormatByteSizeW