UnlockFileEx-Funktion (fileapi.h)

Artikel
08/23/2023

Entsperrt einen Bereich in der angegebenen Datei. Diese Funktion kann entweder synchron oder asynchron ausgeführt werden.

Syntax

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

Parameter

[in] hFile

Ein Handle zur Datei. Das Handle muss entweder mit dem zugriffsrecht GENERIC_READ oder GENERIC_WRITE erstellt worden sein. Weitere Informationen finden Sie unter Dateisicherheit und Zugriffsrechte.

dwReserved

Reservierter Parameter; muss null sein.

[in] nNumberOfBytesToUnlockLow

Der Teil mit niedriger Ordnung der Länge des zu entsperrten Bytebereichs.

[in] nNumberOfBytesToUnlockHigh

Der hochgeordnete Teil der Länge des zu entsperrenden Bytebereichs.

[in, out] lpOverlapped

Ein Zeiger auf eine OVERLAPPED-Struktur , die die Funktion mit der Entsperrungsanforderung verwendet. Diese Struktur enthält den Dateioffset des Anfangs des Entsperrbereichs. Sie müssen das hEvent-Element mit einem gültigen Handle oder 0 initialisieren. Weitere Informationen finden Sie unter Synchrone und asynchrone E/A.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlschlägt, ist der Rückgabewert null oder NULL. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Bemerkungen

Durch das Entsperren einer Region einer Datei wird eine zuvor erworbene Sperre für die Datei freigegeben. Die zu entsperrende Region muss genau einer vorhandenen gesperrten Region entsprechen. Zwei angrenzende Bereiche einer Datei können nicht separat gesperrt und dann mithilfe einer einzelnen Region entsperrt werden, die sich über beide gesperrte Regionen erstreckt.

Sperren werden freigegeben, bevor die Verarbeitung der CloseHandle-Funktion abgeschlossen ist.

Unter Windows 8 und Windows Server 2012 wird diese Funktion von den folgenden Technologien unterstützt.

Technologie	Unterstützt
SMB 3.0-Protokoll (Server Message Block)	Ja
SMB 3.0 Transparent Failover (TFO)	Ja
SMB 3.0 mit Dateifreigaben mit horizontaler Skalierung (SO)	Ja
Dateisystem mit freigegebenen Clustervolumes (CsvFS)	Ja
Robustes Dateisystem (Resilient File System, ReFS)	Ja

Anforderungen


Unterstützte Mindestversion (Client)	Windows XP [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	fileapi.h (Einschließen von Windows.h)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll