Função GetDiskFreeSpaceW (fileapi.h)

  • Artigo

Recupera informações sobre o disco especificado, incluindo a quantidade de espaço livre no disco.

Sintaxe

BOOL GetDiskFreeSpaceW(
  [in]  LPCWSTR lpRootPathName,
  [out] LPDWORD lpSectorsPerCluster,
  [out] LPDWORD lpBytesPerSector,
  [out] LPDWORD lpNumberOfFreeClusters,
  [out] LPDWORD lpTotalNumberOfClusters
);

Parâmetros

[in] lpRootPathName

O diretório raiz do disco para o qual as informações devem ser retornadas. Se esse parâmetro for NULL, a função usará a raiz do disco atual. Se esse parâmetro for um nome UNC, ele deverá incluir uma barra invertida à direita (por exemplo, "\\MyServer\MyShare\"). Além disso, uma especificação de unidade deve ter uma barra invertida à direita (por exemplo, "C:\"). O aplicativo de chamada deve ter direitos de acesso FILE_LIST_DIRECTORY para esse diretório.

[out] lpSectorsPerCluster

Um ponteiro para uma variável que recebe o número de setores por cluster.

[out] lpBytesPerSector

Um ponteiro para uma variável que recebe o número de bytes por setor.

[out] lpNumberOfFreeClusters

Um ponteiro para uma variável que recebe o número total de clusters gratuitos no disco que estão disponíveis para o usuário associado ao thread de chamada.

Se as cotas de disco por usuário estiverem em uso, esse valor poderá ser menor que o número total de clusters gratuitos no disco.

[out] lpTotalNumberOfClusters

Um ponteiro para uma variável que recebe o número total de clusters no disco que estão disponíveis para o usuário associado ao thread de chamada.

Se as cotas de disco por usuário estiverem em uso, esse valor poderá ser menor que o número total de clusters no disco.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

A função GetDiskFreeSpaceEx permite evitar parte da aritmética exigida pela função GetDiskFreeSpace .

Comportamento de link simbólico – se o caminho apontar para um link simbólico, a operação será executada no destino.

Observação

O cabeçalho fileapi.h define GetDiskFreeSpace 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 XP [aplicativos da área de trabalho | aplicativos UWP]
Servidor mínimo com suporte Windows Server 2003 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho fileapi.h (inclua Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

Funções do gerenciamento de disco

GetDiskFreeSpaceEx

GetDriveType