UnlockFileEx

関数

LockFileExでロックした範囲を解除する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL UnlockFileEx(
    HANDLE hFile,
    DWORD dwReserved,   // optional
    DWORD nNumberOfBytesToUnlockLow,
    DWORD nNumberOfBytesToUnlockHigh,
    OVERLAPPED* lpOverlapped
);

パラメーター

名前	型	方向	説明
hFile	HANDLE	in	ファイルへのハンドル。このハンドルは、 GENERIC_READ または GENERIC_WRITE アクセス権のいずれかで作成されている必要があります。詳細については、 File Security and Access Rights を参照してください。
dwReserved	DWORD	optional	予約済みパラメーター。0 にする必要があります。
nNumberOfBytesToUnlockLow	DWORD	in	ロックを解除するバイト範囲の長さの下位部分。
nNumberOfBytesToUnlockHigh	DWORD	in	ロックを解除するバイト範囲の長さの上位部分。
lpOverlapped	OVERLAPPED*	inout	この関数がロック解除要求に使用する OVERLAPPED 構造体へのポインター。この構造体には、ロック解除範囲の先頭のファイルオフセットが含まれます。hEvent メンバーは、有効なハンドルまたは 0 で初期化する必要があります。詳細については、 Synchronous and Asynchronous I/O を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定されたファイル内の領域のロックを解除します。この関数は同期的にも非同期的にも動作できます。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 または NULL です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

ファイルの領域のロックを解除すると、そのファイルに対して以前に取得したロックが解放されます。ロックを解除する領域は、既存のロックされた領域と正確に一致する必要があります。ファイルの隣接する 2 つの領域を別々にロックしてから、両方のロックされた領域にまたがる単一の領域を使用してロックを解除することはできません。

ロックは、CloseHandle 関数の処理が完了する前に解放されます。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	はい
SMB 3.0 Transparent Failover (TFO)	はい
SMB 3.0 with Scale-out File Shares (SO)	はい
Cluster Shared Volume File System (CsvFS)	はい
Resilient File System (ReFS)	はい

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL UnlockFileEx(
    HANDLE hFile,
    DWORD dwReserved,   // optional
    DWORD nNumberOfBytesToUnlockLow,
    DWORD nNumberOfBytesToUnlockHigh,
    OVERLAPPED* lpOverlapped
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool UnlockFileEx(
    IntPtr hFile,   // HANDLE
    uint dwReserved,   // DWORD optional
    uint nNumberOfBytesToUnlockLow,   // DWORD
    uint nNumberOfBytesToUnlockHigh,   // DWORD
    IntPtr lpOverlapped   // OVERLAPPED* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnlockFileEx(
    hFile As IntPtr,   ' HANDLE
    dwReserved As UInteger,   ' DWORD optional
    nNumberOfBytesToUnlockLow As UInteger,   ' DWORD
    nNumberOfBytesToUnlockHigh As UInteger,   ' DWORD
    lpOverlapped As IntPtr   ' OVERLAPPED* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFile : HANDLE
' dwReserved : DWORD optional
' nNumberOfBytesToUnlockLow : DWORD
' nNumberOfBytesToUnlockHigh : DWORD
' lpOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function UnlockFileEx Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal dwReserved As Long, _
    ByVal nNumberOfBytesToUnlockLow As Long, _
    ByVal nNumberOfBytesToUnlockHigh As Long, _
    ByVal lpOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

UnlockFileEx = ctypes.windll.kernel32.UnlockFileEx
UnlockFileEx.restype = wintypes.BOOL
UnlockFileEx.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.DWORD,  # dwReserved : DWORD optional
    wintypes.DWORD,  # nNumberOfBytesToUnlockLow : DWORD
    wintypes.DWORD,  # nNumberOfBytesToUnlockHigh : DWORD
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
UnlockFileEx = Fiddle::Function.new(
  lib['UnlockFileEx'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
    -Fiddle::TYPE_INT,  # nNumberOfBytesToUnlockLow : DWORD
    -Fiddle::TYPE_INT,  # nNumberOfBytesToUnlockHigh : DWORD
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn UnlockFileEx(
        hFile: *mut core::ffi::c_void,  // HANDLE
        dwReserved: u32,  // DWORD optional
        nNumberOfBytesToUnlockLow: u32,  // DWORD
        nNumberOfBytesToUnlockHigh: u32,  // DWORD
        lpOverlapped: *mut OVERLAPPED  // OVERLAPPED* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool UnlockFileEx(IntPtr hFile, uint dwReserved, uint nNumberOfBytesToUnlockLow, uint nNumberOfBytesToUnlockHigh, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_UnlockFileEx' -Namespace Win32 -PassThru
# $api::UnlockFileEx(hFile, dwReserved, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh, lpOverlapped)

#uselib "KERNEL32.dll"
#func global UnlockFileEx "UnlockFileEx" sptr, sptr, sptr, sptr, sptr
; UnlockFileEx hFile, dwReserved, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh, varptr(lpOverlapped)   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; dwReserved : DWORD optional -> "sptr"
; nNumberOfBytesToUnlockLow : DWORD -> "sptr"
; nNumberOfBytesToUnlockHigh : DWORD -> "sptr"
; lpOverlapped : OVERLAPPED* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global UnlockFileEx "UnlockFileEx" sptr, int, int, int, var
; res = UnlockFileEx(hFile, dwReserved, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh, lpOverlapped)
; hFile : HANDLE -> "sptr"
; dwReserved : DWORD optional -> "int"
; nNumberOfBytesToUnlockLow : DWORD -> "int"
; nNumberOfBytesToUnlockHigh : DWORD -> "int"
; lpOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global UnlockFileEx "UnlockFileEx" sptr, int, int, int, sptr
; res = UnlockFileEx(hFile, dwReserved, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh, varptr(lpOverlapped))
; hFile : HANDLE -> "sptr"
; dwReserved : DWORD optional -> "int"
; nNumberOfBytesToUnlockLow : DWORD -> "int"
; nNumberOfBytesToUnlockHigh : DWORD -> "int"
; lpOverlapped : OVERLAPPED* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。