Função CreateFileA (fileapi.h)
Cria ou abre um arquivo ou dispositivo de E/S. Os dispositivos de E/S mais usados são: arquivo, fluxo de arquivos, diretório, disco físico, volume, buffer de console, unidade de fita, recurso de comunicação, slot de correio 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, o que resulta em um identificador que pode ser usado para E/S transacionada, 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.
Por padrão, o nome é limitado a caracteres MAX_PATH. Para estender esse limite para 32.767 caracteres largos, preencha "\\?\" para o caminho. Para obter mais informações, confira Nomear arquivos, caminhos e namespaces.
Dica
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 de comprimento do caminho" de Arquivos de Nomenclatura, Caminhos e Namespaces para obter detalhes.
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, dois-pontos e, em seguida, o nome do fluxo. Para obter mais informações, consulte Fluxos de arquivos.
[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, Segurança de Arquivos e Direitos de Acesso, 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 tenha 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.
[in, optional] lpSecurityAttributes
Um ponteiro para uma estrutura 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 um SECURITY_DESCRIPTOR para um arquivo ou dispositivo. Se esse membro for NULL, o arquivo ou dispositivo associado ao identificador retornado será atribuído a 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:
[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 controlar o comportamento de cache de arquivos ou dispositivos, modos de acesso e outros sinalizadores de finalidade especial. Eles combinam com qualquer valor 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 os atributos e tabelas de sinalizadores.
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 |
|---|---|
|
O arquivo deve ser arquivado. Os aplicativos usam esse atributo para marcar arquivos para backup ou remoção. |
|
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 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. |
|
O arquivo está oculto. Não inclua em uma listagem de diretório comum. |
|
O arquivo não tem outros atributos definidos. Este atributo é válido apenas quando usado sozinho. |
|
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 esse atributo arbitrariamente. |
|
O arquivo é somente leitura. Os aplicativos podem ler o arquivo, mas não podem gravá-lo ou excluí-lo. |
|
O arquivo faz parte ou é usado exclusivamente por um sistema operacional. |
|
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 |
|---|---|
|
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. |
|
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 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. |
|
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 de disco rígido nem os arquivos mapeados de memória.
Há requisitos estritos para trabalhar com êxito com arquivos abertos com CreateFile usando o sinalizador FILE_FLAG_NO_BUFFERING , para obter detalhes, consulte Buffer de arquivos. |
|
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. |
|
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, independentemente de o filtro que controla ou não o ponto de nova análise estar 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. |
|
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. |
|
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 estar acessíveis por aplicativos gravados para MS-DOS ou Windows de 16 bits. |
|
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 oferecer suporte a E/S armazenada em cache e FILE_FLAG_NO_BUFFERING. Para obter mais informações, consulte a seção Comportamento de cache deste tópico. |
|
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. |
|
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 inversas) for usado. Esse sinalizador não terá efeito se o sistema de arquivos não oferecer suporte a E/S armazenada em cache e FILE_FLAG_NO_BUFFERING. Para obter mais informações, consulte a seção Comportamento de cache deste tópico. |
|
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.
[in, optional] hTemplateFile
Um identificador válido para um arquivo de modelo com o direito de acesso GENERIC_READ . 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 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 especificados.
Se houver falha na função, o valor retornado será INVALID_HANDLE_VALUE. Para obter informações de erro estendidas, chame GetLastError.
Comentários
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 contextos diferentes 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 de 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 prevalente em nomes constantes e nomes de parâmetros devido aos motivos históricos mencionados anteriormente.
Quando um aplicativo for concluído usando 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 itens como compartilhar o arquivo ou dispositivo e confirmar dados em disco. As especificações são indicadas 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 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.
Não é possível usar CreateFile para controlar a compactação, a descompactação ou a 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 posteriormente consultam o descritor de segurança desse arquivo podem determinar e relatar heuristicamente que a herança está em vigor. Para obter mais informações, consulte Propagação automática de ACEs herdáveis.
Conforme indicado 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 diferente de zero, o identificador poderá ser herdado. Portanto, é fundamental que esse membro de 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 do 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.
| Tecnologia | Com suporte |
|---|---|
| Protocolo SMB (SMB) 3.0 | Sim |
| TFO (Failover transparente) do 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 Clusterizado (CsvFS) | Sim |
| ReFS (Sistema de Arquivos Resiliente) | Sim |
Observe que CreateFile com disposição de substituição falhará se for 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. Eles são:- FILE_FLAG_NO_BUFFERING
- FILE_FLAG_RANDOM_ACCESS
- FILE_FLAG_SEQUENTIAL_SCAN
- FILE_FLAG_WRITE_THROUGH
- FILE_ATTRIBUTE_TEMPORARY
Alguns desses sinalizadores não devem ser combinados. Por exemplo, combinar FILE_FLAG_RANDOM_ACCESS com FILE_FLAG_SEQUENTIAL_SCAN é autodestrutivo.
Especificar o sinalizador FILE_FLAG_SEQUENTIAL_SCAN pode aumentar o desempenho de 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 desempenho ideal 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 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 um write-through do cache de hardware local do disco rígido para mídia persistente.
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, resultantes 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. O uso desses 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 desempenho máximo 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 do 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 informa 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 pesquisa o cache para obter informações de arquivo a serem restauradas. As informações armazenadas em cache incluem seu par de nomes curtos/longos e o 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 Obtendo e definindo 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 Como criar e abrir arquivos.
Identificadores de E/S síncronos e assíncronos
CreateFile fornece para criar 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 que usam 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, quer elas concluam ou não a operação de E/S. Conforme mencionado 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 dentro de 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 do sistema de arquivos FAT ou FAT32, não especifique o direito de acesso MAXIMUM_ALLOWED . O acesso ao diretório será negado se isso for feito. Em vez disso , especifique o acesso GENERIC_READ 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, confira 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 .
| String | Significado |
|---|---|
| "\\.\PhysicalDrive0" | Abre a primeira unidade física. |
| "\\.\PhysicalDrive2" | Abre a terceira unidade física. |
Para obter o identificador de unidade física de 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 um ou mais do volume; um volume pode abranger vários discos físicos.
Para obter um exemplo de como abrir 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 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 em cache a critério do sistema de arquivos específico, mesmo quando a opção não armazenado em cache não é especificada em CreateFile. Você deve assumir que todos os sistemas de arquivos da Microsoft abrem identificadores de volume como não em cache. As restrições de E/S não armazenados em cache 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 em cache 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 em cache e siga as restrições de E/S não armazenados em cache.
Dispositivo de alteração
Os códigos de controle IOCTL_CHANGER_* para DeviceIoControl aceitam um identificador para um dispositivo alterador. Para abrir um dispositivo de alteração, use um nome de arquivo do seguinte formulário: "\\.\Changerx" em que 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" em que 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 permitem especificar números de porta COM.
Para obter mais informações sobre comunicações, consulte Comunicações.
Consoles
A função CreateFile pode criar um identificador para entrada do console (CONIN$). Se o processo tiver um identificador aberto 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 deles pode limitar o acesso.
|
| dwShareMode |
Ao abrir 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 |
| 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 | Result |
|---|---|---|
| "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 a extremidade 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árias, 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 ativa, 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 falha com ERROR_PIPE_BUSY.
Para obter mais informações, consulte Pipes.
Exemplos
Operações de arquivo de exemplo são mostradas nos seguintes tópicos:
- Anexar um arquivo a outro arquivo
- Como cancelar operações de E/S pendentes
- Criar um processo filho com entrada e saída redirecionadas
- Criar e usar um arquivo temporário
- FSCTL_RECALL_FILE
- GetFinalPathNameByHandle
- Como bloquear e desbloquear intervalos de bytes em arquivos
- Obtendo um nome de arquivo de um identificador de arquivo
- Obter informações de reconhecimento do sistema de arquivos
- Abrir um arquivo para leitura ou gravação
- Recuperando a hora do Last-Write
- SetFileInformationByHandle
- Teste para o fim de um arquivo
- Usando fibras
- Como usar fluxos
- Como percorrer um buffer de registros de diário de alteração
- Wow64DisableWow64FsRedirection
- Wow64EnableWow64FsRedirection
- Chamando DeviceIoControl
- Configurando um recurso de comunicação
- Monitorando eventos de comunicações
- Processando uma solicitação para remover um dispositivo
Trabalhar com um emaillot é mostrado em Escrevendo em um Emaillot.
Um snippet de código de backup em fita pode ser encontrado em Criando 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 volumes
Como criar, excluir e manter arquivos
IOCTL (Controle de Entrada e Saída do Dispositivo)
Descompactação e compactação de arquivo
Funções de gerenciamento de arquivos
Segurança de arquivo e direitos de acesso
Funções
Como obter e definir informações de arquivo
Tópicos de visão geral
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de