Функция UnlockFileEx (fileapi.h)

Статья
08/23/2023

Разблокирует регион в указанном файле. Эта функция может работать синхронно или асинхронно.

Синтаксис

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

Параметры

[in] hFile

Дескриптор файла. Дескриптор должен быть создан с правом доступа GENERIC_READ или GENERIC_WRITE . Дополнительные сведения см. в разделе Безопасность файлов и права доступа.

dwReserved

Зарезервированный параметр; значение должно быть равно нулю.

[in] nNumberOfBytesToUnlockLow

Часть нижнего порядка длины диапазона байтов, которую необходимо разблокировать.

[in] nNumberOfBytesToUnlockHigh

Часть высокого порядка длины диапазона байтов, которую необходимо разблокировать.

[in, out] lpOverlapped

Указатель на структуру OVERLAPPED , используемую функцией с запросом разблокировки. Эта структура содержит смещение файла начала диапазона разблокировки. Необходимо инициализировать элемент hEvent допустимым дескриптором или нулевым значением. Дополнительные сведения см. в разделе Синхронный и асинхронный ввод-вывод.

Возвращаемое значение

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция завершается сбоем, возвращаемое значение равно нулю или NULL. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Разблокировка области файла снимает ранее полученную блокировку файла. Регион для разблокировки должен точно соответствовать существующему заблокированному региону. Две смежные области файла нельзя заблокировать отдельно, а затем разблокировать с помощью одного региона, охватывающего оба заблокированных региона.

Блокировки освобождаются до завершения обработки функции CloseHandle .

В Windows 8 и Windows Server 2012 эта функция поддерживается следующими технологиями.

Технология	Поддерживается
Протокол SMB 3.0	Да
Прозрачная отработка отказа (TFO) SMB 3.0	Да
SMB 3.0 с масштабируемыми общими папками (SO)	Да
Файловая система общего тома кластера (CSVFS)	Да
Восстанавливаемая файловая система (ReFS)	Да

Требования


Минимальная версия клиента	Windows XP [классические приложения \| Приложения UWP]
Минимальная версия сервера	Windows Server 2003 [классические приложения \| Приложения UWP]
Целевая платформа	Windows
Header	fileapi.h (включая Windows.h)
Библиотека	Kernel32.lib
DLL	Kernel32.dll