Função StrFormatByteSizeEx (shlwapi.h)

  • Artigo

Converte um valor numérico em uma cadeia de caracteres que representa o número em bytes, quilobytes, megabytes ou gigabytes, dependendo do tamanho. Estende StrFormatByteSizeW oferecendo a opção de arredondar para o dígito exibido mais próximo ou descartar dígitos não reproduzidos.

Sintaxe

LWSTDAPI StrFormatByteSizeEx(
        ULONGLONG  ull,
        SFBS_FLAGS flags,
  [out] PWSTR      pszBuf,
        UINT       cchBuf
);

Parâmetros

ull

Tipo: ULONGLONG

O valor numérico a ser convertido.

flags

Tipo: SFBS_FLAGS

Um dos valores de enumeração SFBS_FLAGS que especifica se os dígitos não reproduzidos devem ser arredondados ou truncados. Esse valor não pode ser NULL.

[out] pszBuf

Tipo: PWSTR

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 retornado

Tipo: HRESULT

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

A tabela a seguir ilustra como essa função converte um valor numérico em uma cadeia de caracteres de texto em relação ao sinalizador passado.

Valor numérico Sinalizador Cadeia de caracteres de texto
2147483647 SFBS_FLAGS_ROUND_TO_NEAREST_DISPLAYED_DIGIT 2,00 GB
2147483647 SFBS_FLAGS_TRUNCATE_UNDISPLAYED_DECIMAL_DIGITS 1,99 GB
 

No Windows 10, o tamanho é relatado na base 10 em vez da base 2. Por exemplo, 1 KB é 1000 bytes em vez de 1024.

Requisitos

   
Cliente mínimo com suporte Windows Vista com SP1 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shlwapi.h
Biblioteca Shlwapi.lib
DLL Shlwapi.dll (versão 6.0 ou posterior)

Confira também

StrFormatByteSize64

StrFormatByteSizeA

StrFormatByteSizeW