Função CreateFile2 (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.
Quando chamado de um aplicativo da Windows Store, CreateFile2 é simplificado. Você pode abrir apenas arquivos ou diretórios nos diretórios ApplicationData.LocalFolder ou Package.InstalledLocation. Você não pode abrir pipes nomeados ou emailslots ou criar arquivos criptografados (FILE_ATTRIBUTE_ENCRYPTED).
Sintaxe
HANDLE CreateFile2(
[in] LPCWSTR lpFileName,
[in] DWORD dwDesiredAccess,
[in] DWORD dwShareMode,
[in] DWORD dwCreationDisposition,
[in, optional] LPCREATEFILE2_EXTENDED_PARAMETERS pCreateExParams
);
Parâmetros
[in] lpFileName
O nome do arquivo ou dispositivo a ser criado ou aberto.
Para obter informações sobre nomes de dispositivos especiais, consulte Definindo umde 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 de Fluxos de Arquivos.
[in] dwDesiredAccess
O acesso solicitado ao arquivo ou dispositivo, que pode ser resumido como leitura, gravação, ambos ou nenhum zero).
Os valores mais usados são GENERIC_READ, GENERIC_WRITEou ambos (GENERIC_READ | GENERIC_WRITE). Para obter mais informações, consulte genéricos de direitos de acesso, de direitos de acesso e segurança de arquivos, 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 se GENERIC_READ acesso tivesse 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
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 CreateFile2 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.
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
[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, optional] pCreateExParams
Ponteiro para uma estrutura de CREATEFILE2_EXTENDED_PARAMETERS opcional.
Valor de retorno
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.
Observações
Para compilar um aplicativo que usa a função CreateFile2, defina a macro _WIN32_WINNT como 0x0602 ou posterior. Para obter mais informações, consulte Usando os cabeçalhos do Windows.
CreateFile2 dá suporte à interação de arquivos e à maioria dos outros tipos de dispositivos e mecanismos de E/S disponíveis para desenvolvedores do Windows. Esta seção tenta abordar os diversos problemas que os desenvolvedores podem enfrentar ao usar CreateFile2 em contextos diferentes e com diferentes tipos de E/S. O texto tenta usar a palavra arquivo 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 termo de arquivo é particularmente predominante em nomes constantes e nomes de parâmetros devido às razões históricas mencionadas anteriormente.
Quando um aplicativo for concluído usando o identificador de objeto retornado pelo CreateFile2, 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.
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 CreateFile2 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, de compactação e descompactação de arquivos e de criptografia de arquivo.
Se o lpSecurityAttributes membro da estrutura CREATEFILE2_EXTENDED_PARAMETERS passada no parâmetro pCreateExParams for NULL, o identificador retornado por CreateFile2 não poderá ser herdado por nenhum processo filho que seu aplicativo possa criar. As seguintes informações sobre esse membro também se aplicam:
- Se a variável bInheritHandle membro não for FALSE, que é qualquer valor diferente de 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 .
| Tecnologia | Suportado |
|---|---|
| Protocolo SMB (Bloco de Mensagens do Servidor) 3.0 | Sim |
| TFO (Failover Transparente) do SMB 3.0 | Não |
| SMB 3.0 com Compartilhamentos de Arquivos de Expansão (SO) | Não |
| Sistema de Arquivos de Volume Compartilhado de Cluster (CsvFS) | Sim |
| ReFS (Sistema de Arquivos Resiliente) | Sim |
comportamento simbólico de vínculo
Se a chamada para essa função criar um arquivo, não haverá nenhuma alteração no comportamento. Além disso, considere as seguintes informações sobre o sinalizador de-
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_EXISTINGou FILE_FLAG_DELETE_ON_CLOSE forem especificados, o arquivo afetado será o destino.
Arquivos
Se você renomear ou excluir um arquivo e restaurá-lo pouco 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 CreateFile2 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.
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.
fluxos de arquivos
Em sistemas de arquivos NTFS, você pode usar CreateFile2 para criar fluxos separados em um arquivo. Para obter mais informações, consulte de Fluxos de Arquivos.Diretórios de
Um aplicativo não pode criar um diretório usando CreateFile2, portanto, somente o valor de 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
Ao usar CreateFile2 para abrir um diretório durante a desfragmentação de um volume de 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 About Directory Management.
discos físicos e volumes
O acesso direto ao disco ou a um volume é restrito.Você pode usar a função CreateFile2 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 Em execução 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.
| Corda | 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
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 uma unidade de memória flash), o lpFileName cadeia de caracteres 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.
| Corda | Significado |
|---|---|
| "\\.\A:" | Abre a unidade de disco 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 Nomeando 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 em cache não é especificada no CreateFile2. Você deve assumir que todos os sistemas de arquivos da Microsoft abrem identificadores de volume como não armazenados em cache. As restrições de E/S não 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 localizadas.
Dispositivo changer
Os IOCTL_CHANGER_* códigos de controle para DeviceIoControl aceitar 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" 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 CreateFile2 pode criar um identificador para um recurso de comunicação, como a porta serial COM1. Para recursos de comunicação, o parâmetro dwCreationDispositionPara 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 que os números da porta COM sejam especificados.
Para obter mais informações sobre comunicações, consulte Communications.
Consoles do
A função| 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 é preferível, 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 |
| dwCreationDisposition | Você deve especificar OPEN_EXISTING ao usar CreateFile2 para abrir o console. |
Defina os membros da estrutura de
| Membros | Valor |
|---|---|
| lpSecurityAttributes |
Se você quiser que o console seja herdado, o membro |
|
dwFileAttributes
dwFileFlags dwSecurityQosFlags 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 CreateFile2 falhe; GetLastError retorna ERROR_FILE_NOT_FOUND. |
Emailslots
SePara obter mais informações, consulte Emailslots.
Pipes
Se CreateFile2 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ários, mas depois que ele for aberto, a instância de pipe nomeada 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âmetroSe a função CreateNamedPipe não tiver sido chamada com êxito no servidor antes dessa operação, um pipe não existirá e CreateFile2 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, CreateFile2 falha com ERROR_PIPE_BUSY.
Para obter mais informações, consulte Pipes.
Requisitos
| Requisito | Valor |
|---|---|
| de cliente com suporte mínimo | Windows 8 [aplicativos da área de trabalho | Aplicativos UWP] |
| servidor com suporte mínimo | Windows Server 2012 [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 |
Consulte também
sobre o gerenciamento de diretórios
sobre o gerenciamento de volume
de Backup do
criando, excluindo e mantendo arquivos
controle de entrada e saída do dispositivo (IOCTL)
de compactação e descompactação de arquivos
Funções de gerenciamento de arquivos
de Direitos de Acesso e Segurança de Arquivos
de Fluxos de Arquivos
Funções
obtenção e configuração de informações de arquivo
Tópicos de visão geral