Função UnlockFileEx (fileapi.h)

Artigo
08/23/2023

Desbloqueia uma região no arquivo especificado. Essa função pode operar de forma síncrona ou assíncrona.

Sintaxe

BOOL UnlockFileEx(
  [in]      HANDLE       hFile,
            DWORD        dwReserved,
  [in]      DWORD        nNumberOfBytesToUnlockLow,
  [in]      DWORD        nNumberOfBytesToUnlockHigh,
  [in, out] LPOVERLAPPED lpOverlapped
);

Parâmetros

[in] hFile

Um manipulador para o arquivo. O identificador deve ter sido criado com o direito de acesso GENERIC_READ ou GENERIC_WRITE . Para obter mais informações, consulte Segurança de arquivo e direitos de acesso.

dwReserved

Parâmetro reservado; deve ser zero.

[in] nNumberOfBytesToUnlockLow

A parte de ordem inferior do comprimento do intervalo de bytes a ser desbloqueado.

[in] nNumberOfBytesToUnlockHigh

A parte de alta ordem do comprimento do intervalo de bytes a ser desbloqueado.

[in, out] lpOverlapped

Um ponteiro para uma estrutura OVERLAPPED que a função usa com a solicitação de desbloqueio. Essa estrutura contém o deslocamento de arquivo do início do intervalo de desbloqueio. Você deve inicializar o membro hEvent para um identificador válido ou zero. Para obter mais informações, consulte E/S síncrona e assíncrona.

Valor retornado

Se a função for bem-sucedida, o valor retornado será diferente de zero.

Se a função falhar, o valor retornado será zero ou NULL. Para obter informações de erro estendidas, chame GetLastError.

Comentários

Desbloquear uma região de um arquivo libera um bloqueio adquirido anteriormente no arquivo. A região a ser desbloqueada deve corresponder exatamente a uma região bloqueada existente. Duas regiões adjacentes de um arquivo não podem ser bloqueadas separadamente e desbloqueadas usando uma única região que abrange ambas as regiões bloqueadas.

Os bloqueios são liberados antes que a função CloseHandle termine o processamento.

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

Tecnologia	Com suporte
Protocolo SMB (SMB) 3.0	Sim
TFO (Failover transparente) do SMB 3.0	Sim
SMB 3.0 com compartilhamentos de arquivos de expansão (SO)	Sim
Sistema de arquivos de Volume Compartilhado Clusterizado (CsvFS)	Sim
ReFS (Sistema de Arquivos Resiliente)	Sim

Requisitos


Cliente mínimo com suporte	Windows XP [aplicativos da área de trabalho \| aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2003 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	fileapi.h (inclua Windows.h)
Biblioteca	Kernel32.lib
DLL	Kernel32.dll