Função NtWriteFile (ntifs.h)

A rotina ZwWriteFile grava dados em um arquivo aberto.

Sintaxe

__kernel_entry NTSYSCALLAPI NTSTATUS NtWriteFile(
  [in]           HANDLE           FileHandle,
  [in, optional] HANDLE           Event,
  [in, optional] PIO_APC_ROUTINE  ApcRoutine,
  [in, optional] PVOID            ApcContext,
  [out]          PIO_STATUS_BLOCK IoStatusBlock,
  [in]           PVOID            Buffer,
  [in]           ULONG            Length,
  [in, optional] PLARGE_INTEGER   ByteOffset,
  [in, optional] PULONG           Key
);

Parâmetros

[in] FileHandle

Manipule para o objeto de arquivo. Esse identificador é criado por uma chamada bem-sucedida para NtCreateFile ou NtOpenFile.

[in, optional] Event

Opcionalmente, um identificador para um objeto de evento a ser definido como o estado sinalizado após a conclusão da operação de gravação. Os drivers intermediários e de dispositivo devem definir esse parâmetro como NULL.

[in, optional] ApcRoutine

Esse parâmetro é reservado. Os drivers intermediários e de dispositivo devem definir esse ponteiro como NULL.

[in, optional] ApcContext

Esse parâmetro é reservado. Os drivers intermediários e de dispositivo devem definir esse ponteiro como NULL.

[out] IoStatusBlock

Ponteiro para uma estrutura de IO_STATUS_BLOCK que recebe o status de conclusão final e informações sobre a operação de gravação solicitada. O membro Information recebe o número de bytes realmente gravados no arquivo.

[in] Buffer

Ponteiro para um buffer alocado pelo chamador que contém os dados a serem gravados no arquivo.

[in] Length

O tamanho, em bytes, do buffer apontado por Buffer.

[in, optional] ByteOffset

Ponteiro para uma variável que especifica o deslocamento de bytes inicial no arquivo para iniciar a operação de gravação. Se Length e ByteOffset especificarem uma operação de gravação após a marca de fim de arquivo atual, NtWriteFile estenderá automaticamente o arquivo e atualizará a marca de fim do arquivo; todos os bytes que não são escritos explicitamente entre essas marcas de fim de arquivo antigas e novas são definidos como zero.

Se a chamada para NtCreateFile definir apenas o sinalizador DesiredAccess FILE_APPEND_DATA, ByteOffset será ignorado. Os dados no buffer fornecido, para Bytes de comprimento , são gravados começando no final atual do arquivo.

Se a chamada para NtCreateFile definir um dos sinalizadores CreateOptions , FILE_SYNCHRONOUS_IO_ALERT ou FILE_SYNCHRONOUS_IO_NONALERT, o Gerenciador de E/S manterá a posição do arquivo atual. Nesse caso, o chamador de NtWriteFile pode especificar que o deslocamento de posição do arquivo atual seja usado em vez de um valor byteOffset explícito. Essa especificação pode ser feita usando um dos seguintes métodos:

• *Especifique um ponteiro para um valor LARGE_INTEGER com o membro HighPart definido como -1 e o membro LowPart definido como o valor definido pelo sistema FILE_USE_FILE_POINTER_POSITION.
• Passe um ponteiro NULL para ByteOffset.

NtWriteFile atualiza a posição do arquivo atual adicionando o número de bytes gravados quando conclui a operação de gravação, se estiver usando a posição de arquivo atual mantida pelo Gerenciador de E/S.

Mesmo quando o Gerenciador de E/S está mantendo a posição do arquivo atual, o chamador pode redefinir essa posição passando um valor byteOffset explícito para NtWriteFile. Fazer isso altera automaticamente a posição do arquivo atual para esse valor ByteOffset, executa a operação de gravação e atualiza a posição de acordo com o número de bytes realmente gravados. Essa técnica fornece ao chamador um serviço atômico de busca e gravação.

Também é possível fazer com que uma operação de gravação comece no final atual do arquivo especificando para ByteOffset um ponteiro para um valor de LARGE_INTEGER com HighPart definido como -1 e LowPart definido como FILE_WRITE_TO_END_OF_FILE. Isso funciona independentemente de o Gerenciador de E/S manter a posição do arquivo atual.

[in, optional] Key

Os drivers intermediários e de dispositivo devem definir esse ponteiro como NULL.

Retornar valor

NtWriteFile retorna STATUS_SUCCESS com êxito ou o código de erro NTSTATUS apropriado em caso de falha.

Comentários

Os chamadores de NtWriteFile já devem ter chamado NtCreateFile com o sinalizador FILE_WRITE_DATA, FILE_APPEND_DATA ou GENERIC_WRITE definido no parâmetro DesiredAccess . Observe que ter apenas FILE_APPEND_DATA acesso a um arquivo não permite que o chamador grave em qualquer lugar do arquivo, exceto na marca de fim do arquivo atual, embora ter FILE_WRITE_DATA acesso a um arquivo não impeça o chamador de gravar para ou além do fim de um arquivo.

Se a chamada anterior para NtCreateFile definir o sinalizador CreateOptions FILE_NO_INTERMEDIATE_BUFFERING, os parâmetros Length e ByteOffset como NtWriteFile deverão ser uma parte integrante do tamanho do setor. Para obter mais informações, consulte NtCreateFile.

NtWriteFile inicia a operação de gravação no arquivo em ByteOffset, na posição do arquivo atual ou na marca de fim do arquivo. Ele encerra a operação de gravação quando grava bytes de Comprimento do Buffer. Se necessário, ele estende o comprimento do arquivo e redefine a marca de fim do arquivo.

Se o chamador abriu o arquivo com o sinalizador DesiredAccess SYNCHRONIZE definido, o chamador poderá aguardar essa rotina para definir o FileHandle fornecido para o estado sinalizado.

Os drivers devem chamar NtWriteFile no contexto do processo do sistema em três casos:

• O driver cria o identificador de arquivo que ele passa para NtWriteFile.
• NtWriteFile notifica o driver de conclusão de E/S por meio de um evento criado pelo driver.
• NtWriteFile notifica o driver de conclusão de E/S por meio de uma rotina de retorno de chamada APC que o driver passa para NtWriteFile.

Identificadores de arquivo e evento só são válidos no contexto de processo em que os identificadores são criados. Portanto, para evitar falhas de segurança, o driver deve criar qualquer identificador de arquivo ou evento que ele passe para NtWriteFile no contexto do processo do sistema em vez do contexto de processo em que o driver está.

Da mesma forma, NtWriteFile deverá ser chamado no contexto do processo do sistema se ele notificar o driver de conclusão de E/S por meio de um APC, pois as APCs são sempre acionadas no contexto do thread que emite a solicitação de E/S. Se o driver chamar NtWriteFile no contexto de um processo diferente do processo do sistema, o APC poderá ser adiado indefinidamente ou pode não ser acionado, pois o thread de origem pode nunca entrar em um estado de espera alertável.

Para obter mais informações sobre como trabalhar com arquivos, consulte Usando arquivos em um driver.

Os chamadores de NtWriteFile devem estar em execução em IRQL = PASSIVE_LEVEL e com APCs de kernel especiais habilitadas.

Se a chamada para essa função ocorrer no modo de usuário, você deverá usar o nome "NtWriteFile" em vez de "ZwWriteFile".

Para chamadas de drivers no modo kernel, as versões NtXxx e ZwXxx de uma rotina dos Serviços do Sistema Nativo do Windows podem se comportar de forma diferente na maneira como lidam e interpretam parâmetros de entrada. Para obter mais informações sobre a relação entre as versões NtXxx e ZwXxx de uma rotina, consulte Usando versões Nt e Zw das rotinas dos Serviços de Sistema Nativo.

Requisitos

Confira também

KeInitializeEvent

NtCreateFile

NtQueryInformationFile

NtReadFile

NtSetInformationFile