Compartilhar via

Função SHGetDiskFreeSpaceExW (shellapi.h)

  • Artigo

Recupera informações de espaço em disco para um volume de disco.

Sintaxe

BOOL SHGetDiskFreeSpaceExW(
  [in]            LPCWSTR        pszDirectoryName,
  [out, optional] ULARGE_INTEGER *pulFreeBytesAvailableToCaller,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfBytes,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfFreeBytes
);

Parâmetros

[in] pszDirectoryName

Tipo: LPCTSTR

Uma cadeia de caracteres terminada em nulo que especifica o volume para o qual as informações de tamanho são recuperadas. Isso pode ser uma letra de unidade, um nome UNC ou o caminho de uma pasta. Você não pode usar NULL para representar a unidade atual.

[out, optional] pulFreeBytesAvailableToCaller

Tipo: ULARGE_INTEGER*

Ponteiro para um valor que recebe o número de bytes no volume disponível para o aplicativo de chamada. Se o sistema operacional implementar cotas por usuário, esse valor poderá ser menor que o número total de bytes gratuitos no volume.

[out, optional] pulTotalNumberOfBytes

Tipo: ULARGE_INTEGER*

Ponteiro para um valor que recebe o tamanho total do volume, em bytes.

[out, optional] pulTotalNumberOfFreeBytes

Tipo: ULARGE_INTEGER*

Ponteiro para um valor que recebe o número de bytes de espaço livre no volume.

Valor de retorno

Tipo: BOOL

Retorna verdadeiro se bem-sucedido, false caso contrário.

Observações

A função de nome semelhante SHGetDiskFreeSpace é apenas um alias para SHGetDiskFreeSpaceEx. Quando você chama SHGetDiskFreeSpace você realmente chama essa função.

Essa função chamará a função GetDiskFreeSpaceEx se ela estiver disponível no sistema operacional. Se GetDiskFreeSpaceEx não estiver disponível, ele será emulado chamando a função GetDiskFreeSpace e manipulando os valores retornados. Para obter informações adicionais, consulte a documentação do GetDiskFreeSpaceEx.

Nota

O cabeçalho shellapi.h define SHGetDiskFreeSpaceEx 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 Server 2003 [somente aplicativos da área de trabalho]
da Plataforma de Destino Windows
cabeçalho shellapi.h
biblioteca Shell32.lib
de DLL Shell32.dll (versão 5.0 ou posterior)

Consulte também

GetDiskFreeSpaceEx

SHGetDiskFreeSpace