Функция StrFormatByteSizeA (shlwapi.h)

Статья
11/20/2024

Преобразует числовое значение в строку, представляющую число, выраженное как значение размера в байтах, килобайтах, мегабайтах или гигабайтах в зависимости от размера. Отличается от 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 Профессиональный, Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	shlwapi.h
библиотеки	Shlwapi.lib
DLL	Shlwapi.dll (версия 4.71 или более поздняя)

См. также

StrFormatByteSize64

StrFormatByteSizeEx

StrFormatByteSizeW

Поделиться через