Função FindFirstFileW (fileapi.h)

Artigo
11/20/2024

Pesquisa um diretório em busca de um arquivo ou subdiretório com um nome que corresponda a um nome específico (ou nome parcial se curingas forem usados).

Para especificar atributos adicionais a serem usados em uma pesquisa, use a função FindFirstFileEx.

Para executar essa operação como uma operação transacionada, use a função FindFirstFileTransacted.

Sintaxe

HANDLE FindFirstFileW(
  [in]  LPCWSTR            lpFileName,
  [out] LPWIN32_FIND_DATAW lpFindFileData
);

Parâmetros

[in] lpFileName

O diretório ou caminho e o nome do arquivo. O nome do arquivo pode incluir caracteres curinga, por exemplo, um asterisco (*) ou um ponto de interrogação (?).

Esse parâmetro não deve ser NULL, uma cadeia de caracteres inválida (por exemplo, uma cadeia de caracteres vazia ou uma cadeia de caracteres que está faltando o caractere nulo de terminação) ou terminar em uma barra invertida à direita (\).

Se a cadeia de caracteres terminar com um curinga, um período (.) ou um nome de diretório, o usuário deverá ter permissões de acesso para a raiz e todos os subdiretórios no caminho.

Por padrão, o nome é limitado a MAX_PATH caracteres. Para estender esse limite para 32.767 caracteres de largura, acrescente "\\?\" ao caminho. Para obter mais informações, consulte Arquivos de Nomenclatura, Caminhos e Namespaces.

Ponta

A partir do Windows 10, versão 1607, você pode optar por remover a limitação de MAX_PATH sem acrescentar "\\?\". Consulte a seção "Limitação máxima do comprimento do caminho" de arquivos de nomenclatura, caminhos e namespaces para obter detalhes.

[out] lpFindFileData

Um ponteiro para a estrutura de WIN32_FIND_DATA que recebe informações sobre um arquivo ou diretório encontrado.

Valor de retorno

Se a função for bem-sucedida, o valor retornado será um identificador de pesquisa usado em uma chamada subsequente para findNextFile ou FindClosee o parâmetro lpFindFileData contém informações sobre o primeiro arquivo ou diretório encontrado.

Se a função falhar ou não localizar arquivos da cadeia de caracteres de pesquisa no parâmetro lpFileName, o valor retornado será INVALID_HANDLE_VALUE e o conteúdo de lpFindFileData será indeterminado. Para obter informações de erro estendidas, chame a função GetLastError.

Se a função falhar porque nenhum arquivo correspondente pode ser encontrado, a função GetLastError retornará ERROR_FILE_NOT_FOUND.

Observações

A função FindFirstFile abre um identificador de pesquisa e retorna informações sobre o primeiro arquivo que o sistema de arquivos encontra com um nome que corresponde ao padrão especificado. Esse pode ou não ser o primeiro arquivo ou diretório que aparece em um aplicativo de listagem de diretório (como o comando dir) quando fornecido o mesmo padrão de cadeia de caracteres de nome de arquivo. Isso ocorre porque FindFirstFile não faz nenhuma classificação dos resultados da pesquisa. Para obter informações adicionais, consulte FindNextFile.

A lista a seguir identifica algumas outras características de pesquisa:

A pesquisa é executada estritamente no nome do arquivo, não em nenhum atributo, como uma data ou um tipo de arquivo (para outras opções, consulte FindFirstFileEx).
A pesquisa inclui os nomes de arquivo longos e curtos.
Uma tentativa de abrir uma pesquisa com uma barra invertida à direita sempre falha.
Passar uma cadeia de caracteres inválida, NULL ou uma cadeia de caracteres vazia para o parâmetro lpFileName não é um uso válido dessa função. Os resultados nesse caso são indefinidos.

Observação Em casos raros ou em um sistema fortemente carregado, as informações de atributo de arquivo em sistemas de arquivos NTFS podem não estar atuais no momento em que essa função é chamada. Para ter certeza de obter os atributos atuais de arquivo do sistema de arquivos NTFS, chame a função GetFileInformationByHandle.

Depois que o identificador de pesquisa for estabelecido, você poderá usá-lo para pesquisar outros arquivos que correspondam ao mesmo padrão usando a função FindNextFile.

Quando o identificador de pesquisa não for mais necessário, feche-o usando a função FindClose, não CloseHandle.

Conforme indicado anteriormente, você não pode usar uma barra invertida à direita (\) no lpFileName cadeia de caracteres de entrada para FindFirstFile, portanto, pode não ser óbvio como pesquisar diretórios raiz. Se você quiser ver arquivos ou obter os atributos de um diretório raiz, as seguintes opções se aplicarão:

Para examinar arquivos em um diretório raiz, você pode usar "C:\*" e percorrer o diretório usando FindNextFile.
Para obter os atributos de um diretório raiz, use a função GetFileAttributes.

Observação Anexar a cadeia de caracteres "\\?\" não permite o acesso ao diretório raiz.

Em compartilhamentos de rede, você pode usar um lpFileName na forma do seguinte: "\\Server\Share\*". No entanto, você não pode usar um lpFileName que aponta para o compartilhamento em si; por exemplo, "\\Server\Share" não é válido.

Para examinar um diretório que não é um diretório raiz, use o caminho para esse diretório, sem uma barra invertida à direita. Por exemplo, um argumento de "C:\Windows" retorna informações sobre o diretório "C:\Windows", não sobre um diretório ou arquivo em "C:\Windows". Para examinar os arquivos e diretórios em "C:\Windows", use um lpFileName de "C:\Windows\*".

Lembre-se de que algum outro thread ou processo pode criar ou excluir um arquivo com esse nome entre o tempo que você consulta o resultado e o tempo em que você age sobre as informações. Se essa for uma preocupação potencial para seu aplicativo, uma solução possível é usar a função CreateFile com CREATE_NEW (que falha se o arquivo existir) ou OPEN_EXISTING (que falhará se o arquivo não existir).

Se você estiver escrevendo um aplicativo de 32 bits para listar todos os arquivos em um diretório e o aplicativo puder ser executado em um computador de 64 bits, você deve chamar a função Wow64DisableWow64FsRedirection antes de chamar FindFirstFile e chamar Wow64RevertWow64FsRedirection após a última chamada para FindNextFile. Para obter mais informações, consulte do Redirecionador do Sistema de Arquivos.

Se o caminho apontar para um link simbólico, o buffer de WIN32_FIND_DATA conterá informações sobre o link simbólico, não o destino.

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

Tecnologia	Suportado
Protocolo SMB (Bloco de Mensagens do Servidor) 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 de Cluster (CsvFS)	Sim
ReFS (Sistema de Arquivos Resiliente)	Sim

Exemplos

O exemplo C++ a seguir mostra um uso mínimo de FindFirstFile.

#include <windows.h>
#include <tchar.h>
#include <stdio.h>

void _tmain(int argc, TCHAR *argv[])
{
   WIN32_FIND_DATA FindFileData;
   HANDLE hFind;

   if( argc != 2 )
   {
      _tprintf(TEXT("Usage: %s [target_file]\n"), argv[0]);
      return;
   }

   _tprintf (TEXT("Target file is %s\n"), argv[1]);
   hFind = FindFirstFile(argv[1], &FindFileData);
   if (hFind == INVALID_HANDLE_VALUE) 
   {
      printf ("FindFirstFile failed (%d)\n", GetLastError());
      return;
   } 
   else 
   {
      _tprintf (TEXT("The first file found is %s\n"), 
                FindFileData.cFileName);
      FindClose(hFind);
   }
}

Para obter outro exemplo, consulte Listando os arquivos em um diretório.

Nota

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