Função CreateFileA (fileapi.h)

Cria ou abre um arquivo ou dispositivo de E/S. Os dispositivos de E/S mais usados são os seguintes: arquivo, fluxo de arquivos, diretório, disco físico, volume, buffer de console, unidade de fita, recurso de comunicação, emaillot e pipe. A função retorna um identificador que pode ser usado para acessar o arquivo ou dispositivo para vários tipos de E/S, dependendo do arquivo ou dispositivo e dos sinalizadores e atributos especificados.

Para executar essa operação como uma operação transacionada, que resulta em um identificador que pode ser usado para E/S transacionado, use a função CreateFileTransacted .

Sintaxe

HANDLE CreateFileA(
  [in]           LPCSTR                lpFileName,
  [in]           DWORD                 dwDesiredAccess,
  [in]           DWORD                 dwShareMode,
  [in, optional] LPSECURITY_ATTRIBUTES lpSecurityAttributes,
  [in]           DWORD                 dwCreationDisposition,
  [in]           DWORD                 dwFlagsAndAttributes,
  [in, optional] HANDLE                hTemplateFile
);

Parâmetros

[in] lpFileName

O nome do arquivo ou dispositivo a ser criado ou aberto. Você pode usar barras (/) ou barras invertidas (\) nesse nome.

Na versão ANSI dessa função, o nome é limitado a MAX_PATH caracteres. Para estender esse limite para 32.767 caracteres de largura, chame a versão Unicode da função e acrescente "\\?\" para o caminho. Para obter mais informações, confira Nomear arquivos, caminhos e namespaces.

Para obter informações sobre nomes de dispositivos especiais, consulte Definindo um nome de dispositivo MS-DOS.

Para criar um fluxo de arquivos, especifique o nome do arquivo, um dois-pontos e, em seguida, o nome do fluxo. Para obter mais informações, consulte Fluxos de Arquivos.

Ponta Começando com Windows 10, versão 1607, para a versão unicode dessa função (CreateFileW), 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.
 

[in] dwDesiredAccess

O acesso solicitado ao arquivo ou dispositivo, que pode ser resumido como leitura, gravação ou 0 para indicar nenhum dos dois).

Os valores mais usados são GENERIC_READ, GENERIC_WRITE ou ambos (GENERIC_READ | GENERIC_WRITE). Para obter mais informações, consulte Direitos de Acesso Genéricos, Direitos de Acesso e Segurança de Arquivos, Constantes de Direitos de Acesso a Arquivos e ACCESS_MASK.

Se esse parâmetro for zero, o aplicativo poderá consultar determinados metadados, como atributos de arquivo, diretório ou dispositivo sem acessar esse arquivo ou dispositivo, mesmo que GENERIC_READ acesso teria sido negado.

Não é possível solicitar um modo de acesso que entre em conflito com o modo de compartilhamento especificado pelo parâmetro dwShareMode em uma solicitação aberta que já tenha um identificador aberto.

Para obter mais informações, consulte a seção Comentários deste tópico e criando e abrindo arquivos.

[in] dwShareMode

O modo de compartilhamento solicitado do arquivo ou dispositivo, que pode ser lido, gravar, ambos, excluir, todos eles ou nenhum (consulte a tabela a seguir). As solicitações de acesso a atributos ou atributos estendidos não são afetadas por esse sinalizador.

Se esse parâmetro for zero e CreateFile for bem-sucedido, o arquivo ou dispositivo não poderá ser compartilhado e não poderá ser aberto novamente até que o identificador para o arquivo ou dispositivo seja fechado. Para obter mais informações, consulte a seção Comentários.

Não é possível solicitar um modo de compartilhamento que entre em conflito com o modo de acesso especificado em uma solicitação existente que tenha um identificador aberto. CreateFile falharia e a função GetLastError retornaria ERROR_SHARING_VIOLATION.

Para habilitar um processo para compartilhar um arquivo ou dispositivo enquanto outro processo tiver o arquivo ou dispositivo aberto, use uma combinação compatível de um ou mais dos valores a seguir. Para obter mais informações sobre combinações válidas desse parâmetro com o parâmetro dwDesiredAccess , consulte Criando e abrindo arquivos.

Nota As opções de compartilhamento para cada identificador aberto permanecem em vigor até que esse identificador seja fechado, independentemente do contexto do processo.
 
Valor Significado
0
0x00000000
Impede que outros processos abram um arquivo ou dispositivo se solicitarem acesso de exclusão, leitura ou gravação.
FILE_SHARE_DELETE
0x00000004
Permite que operações abertas subsequentes em um arquivo ou dispositivo solicitem acesso de exclusão.

Caso contrário, outros processos não poderão abrir o arquivo ou o dispositivo se solicitarem acesso de exclusão.

Se esse sinalizador não for especificado, mas o arquivo ou dispositivo tiver sido aberto para acesso de exclusão, a função falhará.

Nota Excluir o acesso permite excluir e renomear operações.
 
FILE_SHARE_READ
0x00000001
Permite que operações abertas subsequentes em um arquivo ou dispositivo solicitem acesso de leitura.

Caso contrário, outros processos não poderão abrir o arquivo ou o dispositivo se solicitarem acesso de leitura.

Se esse sinalizador não for especificado, mas o arquivo ou o dispositivo tiver sido aberto para acesso de leitura, a função falhará.

FILE_SHARE_WRITE
0x00000002
Permite que operações abertas subsequentes em um arquivo ou dispositivo solicitem acesso de gravação.

Caso contrário, outros processos não poderão abrir o arquivo ou o dispositivo se solicitarem acesso de gravação.

Se esse sinalizador não for especificado, mas o arquivo ou dispositivo tiver sido aberto para acesso de gravação ou tiver um mapeamento de arquivo com acesso de gravação, a função falhará.

[in, optional] lpSecurityAttributes

Um ponteiro para uma estrutura de SECURITY_ATTRIBUTES que contém dois membros de dados separados, mas relacionados: um descritor de segurança opcional e um valor booliano que determina se o identificador retornado pode ser herdado por processos filho.

Este parâmetro pode ser NULL.

Se esse parâmetro for NULL, o identificador retornado por CreateFile não poderá ser herdado por nenhum processo filho que o aplicativo possa criar e o arquivo ou dispositivo associado ao identificador retornado obterá um descritor de segurança padrão.

O membro lpSecurityDescriptor da estrutura especifica uma SECURITY_DESCRIPTOR para um arquivo ou dispositivo. Se esse membro for NULL, o arquivo ou o dispositivo associado ao identificador retornado receberá um descritor de segurança padrão.

CreateFile ignora o membro lpSecurityDescriptor ao abrir um arquivo ou dispositivo existente, mas continua a usar o membro bInheritHandle .

O membro bInheritHandle da estrutura especifica se o identificador retornado pode ser herdado.

Para obter mais informações, consulte a seção Comentários.

[in] dwCreationDisposition

Uma ação a ser tomada em um arquivo ou dispositivo que existe ou não existe.

Para dispositivos que não sejam arquivos, esse parâmetro geralmente é definido como OPEN_EXISTING.

Para obter mais informações, consulte a seção Comentários.

Esse parâmetro deve ser um dos seguintes valores, que não podem ser combinados:

Valor Significado
CREATE_ALWAYS
2
Cria um novo arquivo, sempre.

Se o arquivo especificado existir e for gravável, a função substituirá o arquivo, a função terá êxito e o código de último erro será definido como ERROR_ALREADY_EXISTS (183).

Se o arquivo especificado não existir e for um caminho válido, um novo arquivo será criado, a função terá êxito e o código de último erro será definido como zero.

Para obter mais informações, consulte a seção Comentários deste tópico.

CREATE_NEW
1
Cria um novo arquivo, somente se ele ainda não existir.

Se o arquivo especificado existir, a função falhará e o código de último erro será definido como ERROR_FILE_EXISTS (80).

Se o arquivo especificado não existir e for um caminho válido para um local gravável, um novo arquivo será criado.

OPEN_ALWAYS
4
Abre um arquivo, sempre.

Se o arquivo especificado existir, a função terá êxito e o código de último erro será definido como ERROR_ALREADY_EXISTS (183).

Se o arquivo especificado não existir e for um caminho válido para um local gravável, a função criará um arquivo e o código de último erro será definido como zero.

OPEN_EXISTING
3
Abre um arquivo ou dispositivo, somente se ele existir.

Se o arquivo ou dispositivo especificado não existir, a função falhará e o código de último erro será definido como ERROR_FILE_NOT_FOUND (2).

Para obter mais informações sobre dispositivos, consulte a seção Comentários.

TRUNCATE_EXISTING
5
Abre um arquivo e o trunca para que seu tamanho seja zero bytes, somente se ele existir.

Se o arquivo especificado não existir, a função falhará e o código de último erro será definido como ERROR_FILE_NOT_FOUND (2).

O processo de chamada deve abrir o arquivo com o bit GENERIC_WRITE definido como parte do parâmetro dwDesiredAccess .

[in] dwFlagsAndAttributes

Os atributos e sinalizadores de arquivo ou dispositivo FILE_ATTRIBUTE_NORMAL sendo o valor padrão mais comum para arquivos.

Esse parâmetro pode incluir qualquer combinação dos atributos de arquivo disponíveis (FILE_ATTRIBUTE_*). Todos os outros atributos de arquivo substituem FILE_ATTRIBUTE_NORMAL.

Esse parâmetro também pode conter combinações de sinalizadores (FILE_FLAG_*) para controle de comportamento de cache de arquivo ou dispositivo, modos de acesso e outros sinalizadores de uso especial. Eles combinam com quaisquer valores FILE_ATTRIBUTE_* .

Esse parâmetro também pode conter informações de SQOS (Qualidade de Serviço de Segurança) especificando o sinalizador SECURITY_SQOS_PRESENT . Informações adicionais de sinalizadores relacionados ao SQOS são apresentadas na tabela seguindo as tabelas de atributos e sinalizadores.

Nota Quando CreateFile abre um arquivo existente, ele geralmente combina os sinalizadores de arquivo com os atributos de arquivo do arquivo existente e ignora todos os atributos de arquivo fornecidos como parte de dwFlagsAndAttributes. Casos especiais são detalhados em Criar e Abrir Arquivos.
 
Alguns dos atributos e sinalizadores de arquivo a seguir só podem se aplicar a arquivos e não necessariamente a todos os outros tipos de dispositivos que o CreateFile pode abrir. Para obter informações adicionais, consulte a seção Comentários deste tópico e criando e abrindo arquivos.

Para obter acesso mais avançado aos atributos de arquivo, consulte SetFileAttributes. Para obter uma lista completa de todos os atributos de arquivo com seus valores e descrições, consulte Constantes de Atributo de Arquivo.

Atributo Significado
FILE_ATTRIBUTE_ARCHIVE
32 (0x20)
O arquivo deve ser arquivado. Os aplicativos usam esse atributo para marcar arquivos para backup ou remoção.
FILE_ATTRIBUTE_ENCRYPTED
16384 (0x4000)
O arquivo ou diretório está criptografado. Para um arquivo, isso significa que todos os dados do arquivo são criptografados. Para um diretório, isso significa que a criptografia é o padrão para arquivos e subdiretórios recém-criados. Para obter mais informações, consulte a Criptografia de Arquivo.

Esse sinalizador não terá efeito se FILE_ATTRIBUTE_SYSTEM também for especificado.

Esse sinalizador não tem suporte nas edições Home, Home Premium, Starter ou ARM do Windows.

FILE_ATTRIBUTE_HIDDEN
2 (0x2)
O arquivo está oculto. Não inclua-o em uma listagem de diretório comum.
FILE_ATTRIBUTE_NORMAL
128 (0x80)
O arquivo não tem outros atributos definidos. Este atributo é válido apenas quando usado sozinho.
FILE_ATTRIBUTE_OFFLINE
4096 (0x1000)
Os dados de um arquivo não estão disponíveis imediatamente. Esse atributo indica que os dados do arquivo são movidos fisicamente para o armazenamento offline. Esse atributo é usado pelo Armazenamento Remoto, o software de gerenciamento de armazenamento hierárquico. Os aplicativos não devem alterar arbitrariamente esse atributo.
FILE_ATTRIBUTE_READONLY
1 (0x1)
O arquivo é somente leitura. Os aplicativos podem ler o arquivo, mas não podem gravar ou excluí-lo.
FILE_ATTRIBUTE_SYSTEM
4 (0x4)
O arquivo faz parte ou é usado exclusivamente por um sistema operacional.
FILE_ATTRIBUTE_TEMPORARY
256 (0x100)
O arquivo está sendo usado para armazenamento temporário.

Para obter mais informações, consulte a seção Comportamento de Cache deste tópico.

 
Sinalizador Significado
FILE_FLAG_BACKUP_SEMANTICS
0x02000000
O arquivo está sendo aberto ou criado para uma operação de backup ou restauração. O sistema garante que o processo de chamada substitua as verificações de segurança de arquivo quando o processo tiver privilégios de SE_BACKUP_NAME e SE_RESTORE_NAME . Para obter mais informações, consulte Alterando privilégios em um token.

Você deve definir esse sinalizador para obter um identificador para um diretório. Um identificador de diretório pode ser passado para algumas funções em vez de um identificador de arquivo. Para obter mais informações, consulte a seção Comentários.

FILE_FLAG_DELETE_ON_CLOSE
0x04000000
O arquivo deve ser excluído imediatamente depois que todos os seus identificadores forem fechados, o que inclui o identificador especificado e os outros identificadores abertos ou duplicados.

Se houver identificadores abertos existentes em um arquivo, a chamada falhará, a menos que todos eles tenham sido abertos com o modo de compartilhamento FILE_SHARE_DELETE .

Solicitações abertas subsequentes do arquivo falharão, a menos que o modo de compartilhamento FILE_SHARE_DELETE seja especificado.

FILE_FLAG_NO_BUFFERING
0x20000000
O arquivo ou dispositivo está sendo aberto sem cache do sistema para leituras e gravações de dados. Esse sinalizador não afeta o cache em disco rígido ou os arquivos mapeados de memória.

Há requisitos rígidos para trabalhar com êxito com arquivos abertos com CreateFile usando o sinalizador FILE_FLAG_NO_BUFFERING , para obter detalhes, consulte Buffer de Arquivos.

FILE_FLAG_OPEN_NO_RECALL
0x00100000
Os dados do arquivo são solicitados, mas devem continuar localizados no armazenamento remoto. Ele não deve ser transportado de volta para o armazenamento local. Esse sinalizador é usado por sistemas de armazenamento remoto.
FILE_FLAG_OPEN_REPARSE_POINT
0x00200000
O processamento normal de ponto de nova análise não ocorrerá; CreateFile tentará abrir o ponto de nova análise. Quando um arquivo é aberto, um identificador de arquivo é retornado, se o filtro que controla ou não o ponto de nova análise está operacional.

Esse sinalizador não pode ser usado com o sinalizador CREATE_ALWAYS .

Se o arquivo não for um ponto de nova análise, esse sinalizador será ignorado.

Para obter mais informações, consulte a seção Comentários.

FILE_FLAG_OVERLAPPED
0x40000000
O arquivo ou dispositivo está sendo aberto ou criado para E/S assíncrona.

Quando as operações de E/S subsequentes forem concluídas nesse identificador, o evento especificado na estrutura OVERLAPPED será definido como o estado sinalizado.

Se esse sinalizador for especificado, o arquivo poderá ser usado para operações simultâneas de leitura e gravação.

Se esse sinalizador não for especificado, as operações de E/S serão serializadas, mesmo que as chamadas para as funções de leitura e gravação especifiquem uma estrutura OVERLAPPED .

Para obter informações sobre considerações ao usar um identificador de arquivo criado com esse sinalizador, consulte a seção Identificadores de E/S síncronos e assíncronos deste tópico.

FILE_FLAG_POSIX_SEMANTICS
0x01000000
O acesso ocorrerá de acordo com as regras POSIX. Isso inclui permitir vários arquivos com nomes, diferentes apenas no caso, para sistemas de arquivos que dão suporte a essa nomenclatura. Use cuidado ao usar essa opção, pois os arquivos criados com esse sinalizador podem não ser acessíveis por aplicativos gravados para MS-DOS ou Windows de 16 bits.
FILE_FLAG_RANDOM_ACCESS
0x10000000
O acesso destina-se a ser aleatório. O sistema pode usar isso como uma dica para otimizar o cache de arquivo.

Esse sinalizador não terá efeito se o sistema de arquivos não der suporte a E/S em cache e FILE_FLAG_NO_BUFFERING.

Para obter mais informações, consulte a seção Comportamento de Cache deste tópico.

FILE_FLAG_SESSION_AWARE
0x00800000
O arquivo ou dispositivo está sendo aberto com reconhecimento de sessão. Se esse sinalizador não for especificado, os dispositivos por sessão (como um dispositivo que usa o Redirecionamento USB RemoteFX) não poderão ser abertos por processos em execução na sessão 0. Esse sinalizador não tem efeito para os chamadores que não estão na sessão 0. Esse sinalizador tem suporte apenas em edições de servidor do Windows.

Windows Server 2008 R2 e Windows Server 2008: Não há suporte para esse sinalizador antes de Windows Server 2012.

FILE_FLAG_SEQUENTIAL_SCAN
0x08000000
O acesso destina-se a ser sequencial do início ao fim. O sistema pode usar isso como uma dica para otimizar o cache de arquivo.

Esse sinalizador não deve ser usado se o read-behind (ou seja, verificações inversa) for usado.

Esse sinalizador não terá efeito se o sistema de arquivos não der suporte a E/S em cache e FILE_FLAG_NO_BUFFERING.

Para obter mais informações, consulte a seção Comportamento de Cache deste tópico.

FILE_FLAG_WRITE_THROUGH
0x80000000
As operações de gravação não passarão por nenhum cache intermediário, elas irão diretamente para o disco.

Para obter informações adicionais, consulte a seção Comportamento de Cache deste tópico.

 

O parâmetro dwFlagsAndAttributes também pode especificar informações do SQOS. Para obter mais informações, consulte Níveis de Representação. Quando o aplicativo de chamada especifica o sinalizador SECURITY_SQOS_PRESENT como parte de dwFlagsAndAttributes, ele também pode conter um ou mais dos valores a seguir.

Sinalizador de segurança Significado
SECURITY_ANONYMOUS
Representa um cliente no nível de representação anônima.
SECURITY_CONTEXT_TRACKING
O modo de acompanhamento de segurança é dinâmico. Se esse sinalizador não for especificado, o modo de controle de segurança será estático.
SECURITY_DELEGATION
Representa um cliente no nível de representação de delegação.
SECURITY_EFFECTIVE_ONLY
Somente os aspectos habilitados do contexto de segurança do cliente estão disponíveis para o servidor. Se você não especificar esse sinalizador, todos os aspectos do contexto de segurança do cliente estarão disponíveis.

Isso permite que o cliente limite os grupos e privilégios que um servidor pode usar ao representar o cliente.

SECURITY_IDENTIFICATION
Representa um cliente no nível de representação de identificação.
SECURITY_IMPERSONATION
Representar um cliente no nível de representação. Esse é o comportamento padrão se nenhum outro sinalizador for especificado junto com o sinalizador SECURITY_SQOS_PRESENT .

[in, optional] hTemplateFile

Um identificador válido para um arquivo de modelo com o GENERIC_READ direito de acesso. O arquivo de modelo fornece atributos de arquivo e atributos estendidos para o arquivo que está sendo criado.

Este parâmetro pode ser NULL.

Ao abrir um arquivo existente, CreateFile ignora esse parâmetro.

Ao abrir um novo arquivo criptografado, o arquivo herda a lista de controle de acesso discricionário de seu diretório pai. Para obter informações adicionais, consulte a Criptografia de Arquivo.

Retornar valor

Se a função for bem-sucedida, o valor retornado será um identificador aberto para o arquivo, dispositivo, pipe nomeado ou slot de email especificado.

Se houver falha na função, o valor retornado será INVALID_HANDLE_VALUE. Para obter informações de erro estendidas, chame GetLastError.

Comentários

O CreateFile foi originalmente desenvolvido especificamente para interação de arquivos, mas desde então foi expandido e aprimorado para incluir a maioria dos outros tipos de dispositivos de E/S e mecanismos disponíveis para desenvolvedores do Windows. Esta seção tenta abordar os diversos problemas que os desenvolvedores podem enfrentar ao usar CreateFile em diferentes contextos e com diferentes tipos de E/S. O texto tenta usar o arquivo de palavra somente ao se referir especificamente aos dados armazenados em um arquivo real em um sistema de arquivos. No entanto, alguns usos do arquivo podem estar se referindo de forma mais geral a um objeto de E/S que dá suporte a mecanismos semelhantes a arquivos. Esse uso liberal do arquivo de termo é particularmente predominante em nomes constantes e nomes de parâmetros devido às razões históricas mencionadas anteriormente.

Quando um aplicativo terminar de usar o identificador de objeto retornado por CreateFile, use a função CloseHandle para fechar o identificador. Isso não só libera recursos do sistema, mas pode ter maior influência em coisas como compartilhar o arquivo ou dispositivo e confirmar dados em disco. Os detalhes são observados neste tópico, conforme apropriado.

Windows Server 2003 e Windows XP: Uma violação de compartilhamento ocorrerá se for feita uma tentativa de abrir um arquivo ou diretório para exclusão em um computador remoto quando o valor do parâmetro dwDesiredAccess for o sinalizador de acesso DELETE (0x00010000) OR'ed com qualquer outro sinalizador de acesso, e o arquivo ou diretório remoto não tiver sido aberto com FILE_SHARE_DELETE. Para evitar a violação de compartilhamento nesse cenário, abra o arquivo ou diretório remoto apenas com o direito de acesso DELETE ou chame DeleteFile sem primeiro abrir o arquivo ou o diretório para exclusão.

Alguns sistemas de arquivos, como o sistema de arquivos NTFS, dão suporte à compactação ou criptografia para arquivos e diretórios individuais. Em volumes que têm um sistema de arquivos montado com esse suporte, um novo arquivo herda os atributos de compactação e criptografia de seu diretório.

Você não pode usar CreateFile para controlar compactação, descompactação ou descriptografia em um arquivo ou diretório. Para obter mais informações, consulte Criando e abrindo arquivos, compactação e descompactação de arquivos e criptografia de arquivos.

Windows Server 2003 e Windows XP: Para fins de compatibilidade com versões anteriores, CreateFile não aplica regras de herança quando você especifica um descritor de segurança em lpSecurityAttributes. Para dar suporte à herança, as funções que consultam posteriormente o descritor de segurança desse arquivo podem determinar e informar heuristicamente que a herança está em vigor. Para obter mais informações, consulte Propagação Automática de ACEs Herdáveis.

Conforme declarado anteriormente, se o parâmetro lpSecurityAttributes for NULL, o identificador retornado por CreateFile não poderá ser herdado por nenhum processo filho que seu aplicativo possa criar. As seguintes informações sobre esse parâmetro também se aplicam:

  • Se a variável de membro bInheritHandle não for FALSE, que é qualquer valor não zero, o identificador poderá ser herdado. Portanto, é fundamental que esse membro da estrutura seja inicializado corretamente para FALSE se você não pretende que o identificador seja herdável.
  • As ACL (listas de controle de acesso) no descritor de segurança padrão para um arquivo ou diretório são herdadas de seu diretório pai.
  • O sistema de arquivos de destino deve dar suporte à segurança em arquivos e diretórios para que o membro lpSecurityDescriptor tenha um efeito sobre eles, o que pode ser determinado usando GetVolumeInformation.
Em Windows 8 e Windows Server 2012, essa função é compatível com as tecnologias a seguir.
Tecnologia Com suporte
Protocolo SMB (Bloco de Mensagens do Servidor) 3.0 Yes
TFO (Failover Transparente) SMB 3.0 Ver comentários
SMB 3.0 com compartilhamentos de arquivos de expansão (SO) Ver comentários
Sistema de Arquivos de Volume Compartilhado de Cluster (CsvFS) Yes
ReFS (Sistema de Arquivos Resiliente) Yes
 

Observe que CreateFile com disposição de substituição falhará se executado em um arquivo em que já há um fluxo de dados alternativo aberto.

Comportamento simbólico do link

Se a chamada para essa função criar um arquivo, não haverá alteração no comportamento. Além disso, considere as seguintes informações sobre FILE_FLAG_OPEN_REPARSE_POINT:
  • Se FILE_FLAG_OPEN_REPARSE_POINT for especificado:
    • Se um arquivo existente for aberto e for um link simbólico, o identificador retornado será um identificador para o link simbólico.
    • Se TRUNCATE_EXISTING ou FILE_FLAG_DELETE_ON_CLOSE forem especificados, o arquivo afetado será um link simbólico.
  • Se FILE_FLAG_OPEN_REPARSE_POINT não for especificado:
    • Se um arquivo existente for aberto e for um link simbólico, o identificador retornado será um identificador para o destino.
    • Se CREATE_ALWAYS, TRUNCATE_EXISTING ou FILE_FLAG_DELETE_ON_CLOSE forem especificados, o arquivo afetado será o destino.

Comportamento de cache

Vários dos valores possíveis para o parâmetro dwFlagsAndAttributes são usados pelo CreateFile para controlar ou afetar como os dados associados ao identificador são armazenados em cache pelo sistema. Elas são:
  • FILE_FLAG_NO_BUFFERING
  • FILE_FLAG_RANDOM_ACCESS
  • FILE_FLAG_SEQUENTIAL_SCAN
  • FILE_FLAG_WRITE_THROUGH
  • FILE_ATTRIBUTE_TEMPORARY
Se nenhum desses sinalizadores for especificado, o sistema usará um esquema de cache padrão de uso geral. Caso contrário, o cache do sistema se comporta conforme especificado para cada sinalizador.

Alguns desses sinalizadores não devem ser combinados. Por exemplo, combinar FILE_FLAG_RANDOM_ACCESS com FILE_FLAG_SEQUENTIAL_SCAN é auto-destrutivo.

Especificar o sinalizador FILE_FLAG_SEQUENTIAL_SCAN pode aumentar o desempenho para aplicativos que leem arquivos grandes usando acesso sequencial. Os ganhos de desempenho podem ser ainda mais perceptíveis para aplicativos que leem arquivos grandes principalmente sequencialmente, mas ocasionalmente ignoram pequenos intervalos de bytes. Se um aplicativo mover o ponteiro do arquivo para acesso aleatório, o melhor desempenho de cache provavelmente não ocorrerá. No entanto, a operação correta ainda é garantida.

Os sinalizadores FILE_FLAG_WRITE_THROUGH e FILE_FLAG_NO_BUFFERING são independentes e podem ser combinados.

Se FILE_FLAG_WRITE_THROUGH for usado, mas FILE_FLAG_NO_BUFFERING também não for especificado, para que o cache do sistema esteja em vigor, os dados serão gravados no cache do sistema, mas serão liberados para o disco sem demora.

Se FILE_FLAG_WRITE_THROUGH e FILE_FLAG_NO_BUFFERING forem especificados, para que o cache do sistema não esteja em vigor, os dados serão imediatamente liberados para o disco sem passar pelo cache do sistema Windows. O sistema operacional também solicita uma gravação do cache de hardware local do disco rígido para mídia persistente.

Nota Nem todo hardware de disco rígido dá suporte a essa funcionalidade de gravação.
 
O uso adequado do sinalizador FILE_FLAG_NO_BUFFERING requer considerações especiais do aplicativo. Para obter mais informações, consulte Buffer de Arquivos.

Uma solicitação de gravação por meio de FILE_FLAG_WRITE_THROUGH também faz com que o NTFS libere quaisquer alterações de metadados, como uma atualização de carimbo de data/hora ou uma operação de renomeação, que resultam do processamento da solicitação. Por esse motivo, o sinalizador FILE_FLAG_WRITE_THROUGH geralmente é usado com o sinalizador FILE_FLAG_NO_BUFFERING como uma substituição para chamar a função FlushFileBuffers após cada gravação, o que pode causar penalidades de desempenho desnecessárias. Usar esses sinalizadores juntos evita essas penalidades. Para obter informações gerais sobre o cache de arquivos e metadados, consulte Cache de Arquivos.

Quando FILE_FLAG_NO_BUFFERING é combinado com FILE_FLAG_OVERLAPPED, os sinalizadores dão o máximo de desempenho assíncrono, pois a E/S não depende das operações síncronas do gerenciador de memória. No entanto, algumas operações de E/S levam mais tempo, porque os dados não estão sendo mantidos no cache. Além disso, os metadados de arquivo ainda podem ser armazenados em cache (por exemplo, ao criar um arquivo vazio). Para garantir que os metadados sejam liberados para o disco, use a função FlushFileBuffers .

Especificar o atributo FILE_ATTRIBUTE_TEMPORARY faz com que os sistemas de arquivos evitem gravar dados de volta no armazenamento em massa se houver memória de cache suficiente disponível, pois um aplicativo exclui um arquivo temporário depois que um identificador é fechado. Nesse caso, o sistema pode evitar totalmente gravar os dados. Embora ele não controle diretamente o cache de dados da mesma forma que os sinalizadores mencionados anteriormente, o atributo FILE_ATTRIBUTE_TEMPORARY diz ao sistema para manter o máximo possível no cache do sistema sem gravar e, portanto, pode ser preocupante para determinados aplicativos.

Arquivos

Se você renomear ou excluir um arquivo e restaurá-lo logo depois, o sistema pesquisará no cache informações de arquivo para restaurar. As informações armazenadas em cache incluem seu par de nomes curto/longo e tempo de criação.

Se você chamar CreateFile em um arquivo que está pendente de exclusão como resultado de uma chamada anterior para DeleteFile, a função falhará. O sistema operacional atrasa a exclusão de arquivos até que todos os identificadores do arquivo sejam fechados. GetLastError retorna ERROR_ACCESS_DENIED.

O parâmetro dwDesiredAccess pode ser zero, permitindo que o aplicativo consulte atributos de arquivo sem acessar o arquivo se o aplicativo estiver em execução com configurações de segurança adequadas. Isso é útil para testar a existência de um arquivo sem abri-lo para acesso de leitura e/ou gravação ou para obter outras estatísticas sobre o arquivo ou diretório. Consulte Obter e definir informações de arquivo e GetFileInformationByHandle.

Se CREATE_ALWAYS e FILE_ATTRIBUTE_NORMAL forem especificados, CreateFile falhará e definirá o último erro como ERROR_ACCESS_DENIED se o arquivo existir e tiver o atributo FILE_ATTRIBUTE_HIDDEN ou FILE_ATTRIBUTE_SYSTEM . Para evitar o erro, especifique os mesmos atributos que o arquivo existente.

Quando um aplicativo cria um arquivo em uma rede, é melhor usar GENERIC_READ | GENERIC_WRITE para dwDesiredAccess do que usar GENERIC_WRITE sozinho. O código resultante é mais rápido, pois o redirecionador pode usar o gerenciador de cache e enviar menos SMBs com mais dados. Essa combinação também evita um problema em que gravar em um arquivo em uma rede pode ocasionalmente retornar ERROR_ACCESS_DENIED.

Para obter mais informações, consulte Criando e abrindo arquivos.

Identificadores de E/S síncronos e assíncronos

O CreateFile fornece a criação de um identificador de arquivo ou dispositivo que seja síncrono ou assíncrono. Um identificador síncrono se comporta de modo que as chamadas de função de E/S usando esse identificador sejam bloqueadas até que sejam concluídas, enquanto um identificador de arquivo assíncrono possibilita que o sistema retorne imediatamente de chamadas de função de E/S, sejam elas concluídas ou não a operação de E/S. Conforme indicado anteriormente, esse comportamento síncrono versus assíncrono é determinado especificando FILE_FLAG_OVERLAPPED dentro do parâmetro dwFlagsAndAttributes . Há várias complexidades e possíveis armadilhas ao usar E/S assíncrona; para obter mais informações, consulte E/S síncrona e assíncrona.

Fluxos de Arquivos

Em sistemas de arquivos NTFS, você pode usar CreateFile para criar fluxos separados em um arquivo. Para obter mais informações, consulte Fluxos de Arquivos.

Diretórios

Um aplicativo não pode criar um diretório usando CreateFile, portanto, somente o valor OPEN_EXISTING é válido para dwCreationDisposition para esse caso de uso. Para criar um diretório, o aplicativo deve chamar CreateDirectory ou CreateDirectoryEx.

Para abrir um diretório usando CreateFile, especifique o sinalizador FILE_FLAG_BACKUP_SEMANTICS como parte de dwFlagsAndAttributes. As verificações de segurança apropriadas ainda se aplicam quando esse sinalizador é usado sem privilégios de SE_BACKUP_NAME e SE_RESTORE_NAME .

Ao usar CreateFile para abrir um diretório durante a desfragmentação de um volume de sistema de arquivos FAT ou FAT32, não especifique o MAXIMUM_ALLOWED direito de acesso. O acesso ao diretório será negado se isso for feito. Especifique o GENERIC_READ acesso direito.

Para obter mais informações, consulte Sobre o Gerenciamento de Diretórios.

Discos físicos e volumes

O acesso direto ao disco ou a um volume é restrito.

Windows Server 2003 e Windows XP: O acesso direto ao disco ou a um volume não é restrito dessa maneira.

Você pode usar a função CreateFile para abrir uma unidade de disco física ou um volume, que retorna um identificador DASD (dispositivo de armazenamento de acesso direto) que pode ser usado com a função DeviceIoControl . Isso permite que você acesse o disco ou o volume diretamente, por exemplo, metadados de disco como a tabela de partição. No entanto, esse tipo de acesso também expõe a unidade de disco ou o volume a uma possível perda de dados, pois uma gravação incorreta em um disco usando esse mecanismo pode tornar seu conteúdo inacessível ao sistema operacional. Para garantir a integridade dos dados, familiarize-se com DeviceIoControl e como outras APIs se comportam de forma diferente com um identificador de acesso direto em vez de um identificador do sistema de arquivos.

Os seguintes requisitos devem ser atendidos para que essa chamada seja bem-sucedida:

  • O chamador deve ter privilégios administrativos. Para obter mais informações, consulte Executar com privilégios especiais.
  • O parâmetro dwCreationDisposition deve ter o sinalizador OPEN_EXISTING .
  • Ao abrir um volume ou disquete, o parâmetro dwShareMode deve ter o sinalizador FILE_SHARE_WRITE .
Nota O parâmetro dwDesiredAccess pode ser zero, permitindo que o aplicativo consulte atributos de dispositivo sem acessar um dispositivo. Isso é útil para um aplicativo determinar o tamanho de uma unidade de disquete e os formatos aos quais ele dá suporte sem a necessidade de um disquete em uma unidade, por exemplo. Ele também pode ser usado para ler estatísticas sem exigir permissão de leitura/gravação de dados de nível superior.
 
Ao abrir uma unidade física x:, a cadeia de caracteres lpFileName deve ser o seguinte formulário: "\\.\PhysicalDriveX". Os números de disco rígido começam em zero. A tabela a seguir mostra alguns exemplos de cadeias de caracteres de unidade física.
String Significado
"\\.\PhysicalDrive0" Abre a primeira unidade física.
"\\.\PhysicalDrive2" Abre a terceira unidade física.
 

Para obter o identificador de unidade física para um volume, abra um identificador para o volume e chame a função DeviceIoControl com IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS. Esse código de controle retorna o número do disco e o deslocamento para cada uma das extensões do volume; um volume pode abranger vários discos físicos.

Para obter um exemplo de abertura de uma unidade física, consulte Chamando DeviceIoControl.

Ao abrir um volume ou uma unidade de mídia removível (por exemplo, uma unidade de disco disquete ou uma pen drive de memória flash), a cadeia de caracteres lpFileName deve ser a seguinte forma: "\.\X:". Não use uma barra invertida à direita (\), que indica o diretório raiz de uma unidade. A tabela a seguir mostra alguns exemplos de cadeias de caracteres de unidade.

String Significado
"\\.\A:" Abre a unidade de disquete A.
"\\.\C:" Abre o volume C: .
"\\.\C:\" Abre o sistema de arquivos do volume C: .
 

Você também pode abrir um volume referindo-se ao nome do volume. Para obter mais informações, consulte Nomenclatura de um volume.

Um volume contém um ou mais sistemas de arquivos montados. Os identificadores de volume podem ser abertos como não armazenados a critério do sistema de arquivos específico, mesmo quando a opção não exibida não for especificada no CreateFile. Você deve assumir que todos os sistemas de arquivos da Microsoft abrem identificadores de volume como não armazenados. As restrições de E/S não armazenados para arquivos também se aplicam a volumes.

Um sistema de arquivos pode ou não exigir alinhamento de buffer, mesmo que os dados não sejam armazenados em cache. No entanto, se a opção não armazenada for especificada ao abrir um volume, o alinhamento do buffer será imposto independentemente do sistema de arquivos no volume. É recomendável em todos os sistemas de arquivos que você abra identificadores de volume como não armazenados e siga as restrições de E/S não exibidas.

Nota Para ler ou gravar nos últimos setores do volume, você deve chamar DeviceIoControl e especificar FSCTL_ALLOW_EXTENDED_DASD_IO. Isso sinaliza que o driver do sistema de arquivos não execute nenhuma verificação de limite de E/S em chamadas de leitura ou gravação de partição. Em vez disso, as verificações de limite são executadas pelo driver do dispositivo.
 

Dispositivo changer

Os códigos de controle IOCTL_CHANGER_* para DeviceIoControl aceitam um identificador para um dispositivo de alteração. Para abrir um dispositivo de alteração, use um nome de arquivo do seguinte formulário: "\\.\Changerx" onde x é um número que indica qual dispositivo abrir, começando com zero. Para abrir o dispositivo de alteração zero em um aplicativo escrito em C ou C++, use o seguinte nome de arquivo: "\\.\Changer0".

Unidades de fita

Você pode abrir unidades de fita usando um nome de arquivo do seguinte formulário: "\\.\TAPEx" onde x é um número que indica qual unidade abrir, começando com a unidade de fita zero. Para abrir a unidade de fita zero em um aplicativo escrito em C ou C++, use o seguinte nome de arquivo: "\\.\TAPE0".

Para obter mais informações, consulte Backup.

Recursos de comunicação

A função CreateFile pode criar um identificador para um recurso de comunicação, como a porta serial COM1. Para recursos de comunicação, o parâmetro dwCreationDisposition deve ser OPEN_EXISTING, o parâmetro dwShareMode deve ser zero (acesso exclusivo) e o parâmetro hTemplateFile deve ser NULL. O acesso de leitura, gravação ou leitura/gravação pode ser especificado e o identificador pode ser aberto para E/S sobreposta.

Para especificar um número de porta COM maior que 9, use a seguinte sintaxe: "\\.\COM10". Essa sintaxe funciona para todos os números de porta e hardware que permite que os números da porta COM sejam especificados.

Para obter mais informações sobre comunicações, consulte Comunicações.

Consoles

A função CreateFile pode criar um identificador para a entrada do console (CONIN$). Se o processo tiver um identificador aberto para ele como resultado de herança ou duplicação, ele também poderá criar um identificador para o buffer de tela ativo (CONOUT$). O processo de chamada deve ser anexado a um console herdado ou alocado pela função AllocConsole . Para identificadores de console, defina os parâmetros CreateFile da seguinte maneira.
Parâmetros Valor
lpFileName Use o valor CONIN$ para especificar a entrada do console.

Use o valor CONOUT$ para especificar a saída do console.

CONIN$ obtém um identificador para o buffer de entrada do console, mesmo que a função SetStdHandle redirecione o identificador de entrada padrão. Para obter o identificador de entrada padrão, use a função GetStdHandle .

CONOUT$ obtém um identificador para o buffer de tela ativo, mesmo que SetStdHandle redirecione o identificador de saída padrão. Para obter o identificador de saída padrão, use GetStdHandle.

dwDesiredAccess GENERIC_READ | GENERIC_WRITE é preferencial, mas qualquer um pode limitar o acesso.
dwShareMode Ao abrir o CONIN$, especifique FILE_SHARE_READ. Ao abrir CONOUT$, especifique FILE_SHARE_WRITE.

Se o processo de chamada herdar o console ou se um processo filho deve ser capaz de acessar o console, esse parâmetro deve ser FILE_SHARE_READ | FILE_SHARE_WRITE.

lpSecurityAttributes Se você quiser que o console seja herdado, o membro bInheritHandle da estrutura SECURITY_ATTRIBUTES deverá ser TRUE.
dwCreationDisposition Você deve especificar OPEN_EXISTING ao usar CreateFile para abrir o console.
dwFlagsAndAttributes Ignorado.
hTemplateFile Ignorado.
 

A tabela a seguir mostra várias configurações de dwDesiredAccess e lpFileName.

lpFileName dwDesiredAccess Resultado
"CON" GENERIC_READ Abre o console para entrada.
"CON" GENERIC_WRITE Abre o console para saída.
"CON" GENERIC_READ | GENERIC_WRITE Faz com que CreateFile falhe; GetLastError retorna ERROR_FILE_NOT_FOUND.
 

Emailslots

Se CreateFile abrir o fim do cliente de um emaillot, a função retornará INVALID_HANDLE_VALUE se o cliente maillot tentar abrir um emaillot local antes que o servidor maillot o tenha criado com a função CreateMailSlot .

Para obter mais informações, consulte Emailslots.

Tubos

Se CreateFile abrir o final do cliente de um pipe nomeado, a função usará qualquer instância do pipe nomeado que esteja no estado de escuta. O processo de abertura pode duplicar o identificador quantas vezes forem necessários, mas depois que ele for aberto, a instância de pipe nomeado não poderá ser aberta por outro cliente. O acesso especificado quando um pipe é aberto deve ser compatível com o acesso especificado no parâmetro dwOpenMode da função CreateNamedPipe .

Se a função CreateNamedPipe não tiver sido chamada com êxito no servidor antes dessa operação, um pipe não existirá e CreateFile falhará com ERROR_FILE_NOT_FOUND.

Se houver pelo menos uma instância de pipe ativo, mas não houver pipes de ouvinte disponíveis no servidor, o que significa que todas as instâncias de pipe estão conectadas no momento, CreateFile falhará com ERROR_PIPE_BUSY.

Para obter mais informações, consulte Pipes.

Exemplos

As operações de arquivo de exemplo são mostradas nos seguintes tópicos:

A E/S do dispositivo físico é demonstrada nos seguintes tópicos: Um exemplo usando pipes nomeados está localizado no Cliente pipe nomeado.

Trabalhar com um emaillot é mostrado por escrito em um Emaillot.

Um snippet de código de backup em fita pode ser encontrado na criação de um aplicativo de backup.

Observação

O cabeçalho fileapi.h define CreateFile 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

   
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

Sobre o Gerenciamento de Diretórios

Sobre o Gerenciamento de Volume

Backup

CloseHandle

Comunicações

CreateDirectory

CreateDirectoryEx

CreateFileTransacted

CreateMailSlot

CreateNamedPipe

Criando, excluindo e mantendo arquivos

DeleteFile

Controle de entrada e saída do dispositivo (IOCTL)

Deviceiocontrol

Compactação e descompactação de arquivos

Criptografia de Arquivo

Funções de gerenciamento de arquivos

Direitos de Acesso e Segurança de Arquivos

Fluxos de Arquivos

Funções

Getlasterror

Portas de conclusão de E/S

Conceitos de E/S

Emailslots

Obtendo e definindo informações de arquivo

Tópicos de visão geral

Pipes

ReadFile

ReadFileEx

Em execução com privilégios especiais

SetFileAttributes

WriteFile

WriteFileEx