Função StrFormatByteSizeA (shlwapi.h)
Converte um valor numérico em uma cadeia de caracteres que representa o número expresso como um valor de tamanho em bytes, quilobytes, megabytes ou gigabytes, dependendo do tamanho. Difere de StrFormatByteSizeW em um tipo de parâmetro.
Sintaxe
PSTR StrFormatByteSizeA(
DWORD dw,
[out] PSTR pszBuf,
UINT cchBuf
);
Parâmetros
dw
Tipo: DWORD
O valor numérico a ser convertido.
[out] pszBuf
Tipo: PSTR
Um ponteiro para um buffer que recebe a cadeia de caracteres convertida.
cchBuf
Tipo: UINT
O tamanho do buffer apontado por pszBuf, em caracteres.
Valor de retorno
Tipo: PSTR
Retorna um ponteiro para a cadeia de caracteres convertida ou NULL se a conversão falhar.
Observações
O primeiro parâmetro dessa função tem um tipo diferente para as versões ANSI e Unicode. Se o valor numérico for um DWORD, você poderá usar StrFormatByteSize com macros de texto para ambos os casos. O compilador converterá o valor numérico em um LONGLONG para o caso Unicode. Se o valor numérico for um LONGLONG, você deverá usar StrFormatByteSizeW explicitamente.
No Windows 10, o tamanho é relatado na base 10 em vez da base 2. Por exemplo, 1 KB é 1000 bytes em vez de 1024.
A tabela a seguir ilustra como essa função converte um valor numérico em uma cadeia de caracteres de texto.
| Valor numérico | Cadeia de caracteres de texto |
|---|---|
| 532 | 532 bytes |
| 1340 | 1,30 KB |
| 23506 | 22,9 KB |
| 2400016 | 2,28 MB |
| 2400000000 | 2,23 GB |
Nota
O cabeçalho shlwapi.h define StrFormatByteSize como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.
Requisitos
| Requisito | Valor |
|---|---|
| de cliente com suporte mínimo | Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho] |
| servidor com suporte mínimo | Windows 2000 Server [somente aplicativos da área de trabalho] |
| da Plataforma de Destino |
Windows |
| cabeçalho | shlwapi.h |
| biblioteca | Shlwapi.lib |
| de DLL |
Shlwapi.dll (versão 4.71 ou posterior) |