Função GetFileInformationByHandle (fileapi.h)

  • Artigo

Recupera informações do arquivo especificado.

Para obter uma versão mais avançada dessa função, consulte GetFileInformationByHandleEx.

Para definir informações de arquivo usando um identificador de arquivo, consulte SetFileInformationByHandle.

Sintaxe

BOOL GetFileInformationByHandle(
  [in]  HANDLE                       hFile,
  [out] LPBY_HANDLE_FILE_INFORMATION lpFileInformation
);

Parâmetros

[in] hFile

Um identificador para o arquivo que contém as informações a serem recuperadas.

Esse identificador não deve ser um identificador de pipe.

[out] lpFileInformation

Um ponteiro para uma estrutura BY_HANDLE_FILE_INFORMATION que recebe as informações do arquivo.

Retornar valor

Se a função for bem-sucedida, o valor retornado será diferente de zero e os dados de informações do arquivo serão contidos no buffer apontado pelo parâmetro lpFileInformation .

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

Comentários

Dependendo dos recursos de rede subjacentes do sistema operacional e do tipo de servidor conectado, a função GetFileInformationByHandle pode falhar, retornar informações parciais ou informações completas para o arquivo fornecido.

Você pode comparar os membros VolumeSerialNumber e FileIndex retornados na estrutura BY_HANDLE_FILE_INFORMATION para determinar se dois caminhos são mapeados para o mesmo destino; por exemplo, você pode comparar dois caminhos de arquivo e determinar se eles são mapeados para o mesmo diretório.

IIn Windows 8 e Windows Server 2012, essa função é compatível com as tecnologias a seguir.

Tecnologia Com suporte
Protocolo SMB (SMB) 3.0 Sim
TFO (Failover transparente) do SMB 3.0 Sim
SMB 3.0 com compartilhamentos de arquivos de expansão (SO) Sim
Sistema de arquivos de Volume Compartilhado Clusterizado (CsvFS) Sim
ReFS (Sistema de Arquivos Resiliente) Sim
 

Operações transacionadas

Se houver uma transação associada ao thread no momento da chamada, a função retornará o tamanho do arquivo compactado da exibição de arquivo isolado. Para obter mais informações, consulte Sobre o NTFS transacional.

Requisitos

Requisito Valor
Cliente mínimo com suporte 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 fileapi.h (inclua Windows.h)
Biblioteca Kernel32.lib
DLL Kernel32.dll

Confira também

Funções de gerenciamento de arquivos

GetFileInformationByHandleEx

SetFileInformationByHandle