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. Pode ser uma letra da unidade, um nome UNC ou o caminho de uma pasta. Não é possível 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.

Retornar valor

Tipo: BOOL

Retornará TRUE se tiver êxito; caso contrário, FALSE .

Comentários

A função de nome semelhante SHGetDiskFreeSpace é apenas um alias para SHGetDiskFreeSpaceEx. Ao chamar 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 de GetDiskFreeSpaceEx.

Observação

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

Confira também

GetDiskFreeSpaceEx

SHGetDiskFreeSpace