Функция StrFormatByteSizeA (shlwapi.h)
Преобразует числовое значение в строку, представляющую число, выраженное в виде значения размера в байтах, килобайтах, мегабайтах или гигабайтах в зависимости от размера. Отличается от StrFormatByteSizeW одним типом параметра.
Синтаксис
PSTR StrFormatByteSizeA(
DWORD dw,
[out] PSTR pszBuf,
UINT cchBuf
);
Параметры
dw
Тип: DWORD
Числовое значение, которое необходимо преобразовать.
[out] pszBuf
Тип: PSTR
Указатель на буфер, получающий преобразованную строку.
cchBuf
Тип: UINT
Размер буфера, на который указывает pszBuf, в символах.
Возвращаемое значение
Тип: PSTR
Возвращает указатель на преобразованную строку или значение NULL в случае сбоя преобразования.
Комментарии
Первый параметр этой функции имеет другой тип для версий ANSI и Юникода. Если числовое значение является DWORD, вы можете использовать StrFormatByteSize с текстовыми макросами в обоих случаях. Компилятор приведет числовое значение к LONGLONG для регистра Юникода. Если числовое значение — LONGLONG, следует явно использовать StrFormatByteSizeW .
В Windows 10 размер указывается в базе 10, а не в базе 2. Например, 1 КБ — это 1000 байт, а не 1024.
В следующей таблице показано, как эта функция преобразует числовое значение в текстовую строку.
| Числовое значение | Текстовая строка |
|---|---|
| 532 | 532 байта |
| 1340 | 1,30 КБ |
| 23506 | 22,9 КБ |
| 2400016 | 2,28 МБ |
| 2400000000 | 2,23 ГБ |
Примечание
Заголовок shlwapi.h определяет StrFormatByteSize в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
| Минимальная версия клиента | Windows 2000 Professional, Windows XP [только классические приложения] |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | shlwapi.h |
| Библиотека | Shlwapi.lib |
| DLL | Shlwapi.dll (версия 4.71 или более поздняя) |