Função StrFormatByteSizeW (shlwapi.h)

  • Artigo

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 StrFormatByteSizeA em um tipo de parâmetro.

Sintaxe

PWSTR StrFormatByteSizeW(
        LONGLONG qdw,
  [out] PWSTR    pszBuf,
        UINT     cchBuf
);

Parâmetros

qdw

Tipo: LONGLONG

O valor numérico a ser convertido.

[out] pszBuf

Tipo: PWSTR

Um ponteiro para um buffer que, quando essa função retorna com êxito, recebe o número convertido.

cchBuf

Tipo: UINT

O tamanho do buffer apontado por pszBuf, em caracteres.

Retornar valor

Tipo: PWSTR

Retorna um ponteiro para a cadeia de caracteres convertida ou NULL se a conversão falhar.

Comentários

O primeiro parâmetro dessa função tem tipos diferentes 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 longlong, você deverá usar StrFormatByteSizeW explicitamente.

Em 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
 

Observação

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 de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shlwapi.h
Biblioteca Shlwapi.lib
DLL Shlwapi.dll (versão 4.71 ou posterior)

Confira também

StrFormatByteSize64

StrFormatByteSizeA

StrFormatByteSizeEx