Win32 API 日本語リファレンス
ホーム › Storage.FileSystem › UnlockFile

UnlockFile

関数
LockFileでロックした範囲を解除する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL UnlockFile(
    HANDLE hFile,
    DWORD dwFileOffsetLow,
    DWORD dwFileOffsetHigh,
    DWORD nNumberOfBytesToUnlockLow,
    DWORD nNumberOfBytesToUnlockHigh
);

パラメーター

名前型方向説明
hFileHANDLEinLockFile でロックされた領域を含むファイルへのハンドルです。このファイルハンドルは、GENERIC_READ または GENERIC_WRITE のいずれかのアクセス権を指定して作成されている必要があります。詳細については、 File Security and Access Rights を参照してください。
dwFileOffsetLowDWORDinロックされた領域が始まる、ファイル内の開始バイトオフセットの下位ワードです。
dwFileOffsetHighDWORDinロックされた領域が始まる、ファイル内の開始バイトオフセットの上位ワードです。
nNumberOfBytesToUnlockLowDWORDinロックを解除するバイト範囲の長さの下位ワードです。
nNumberOfBytesToUnlockHighDWORDinロックを解除するバイト範囲の長さの上位ワードです。

戻り値の型: BOOL

公式ドキュメント

オープンされているファイル内の領域のロックを解除します。

戻り値

関数が成功した場合、戻り値は 0 以外になります。

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

解説(Remarks)

この関数は常に同期的に動作しますが、完了ポートがファイルハンドルに関連付けられている場合でも、完了エントリをキューに登録しないことがあります。

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

プロセスがファイルの一部をロックしたまま終了したり、未解除のロックを持つファイルをクローズしたりした場合、それらのロックはオペレーティングシステムによって解除されます。ただし、オペレーティングシステムがこれらのロックを解除するのに要する時間は、利用可能なシステムリソースに依存します。そのため、プロセスは終了時に、ロックしたすべてのファイルを明示的にロック解除することを推奨します。これを行わないと、オペレーティングシステムがまだロックを解除していない場合に、これらのファイルへのアクセスが拒否される可能性があります。

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 UnlockFile(
    HANDLE hFile,
    DWORD dwFileOffsetLow,
    DWORD dwFileOffsetHigh,
    DWORD nNumberOfBytesToUnlockLow,
    DWORD nNumberOfBytesToUnlockHigh
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool UnlockFile(
    IntPtr hFile,   // HANDLE
    uint dwFileOffsetLow,   // DWORD
    uint dwFileOffsetHigh,   // DWORD
    uint nNumberOfBytesToUnlockLow,   // DWORD
    uint nNumberOfBytesToUnlockHigh   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnlockFile(
    hFile As IntPtr,   ' HANDLE
    dwFileOffsetLow As UInteger,   ' DWORD
    dwFileOffsetHigh As UInteger,   ' DWORD
    nNumberOfBytesToUnlockLow As UInteger,   ' DWORD
    nNumberOfBytesToUnlockHigh As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hFile : HANDLE
' dwFileOffsetLow : DWORD
' dwFileOffsetHigh : DWORD
' nNumberOfBytesToUnlockLow : DWORD
' nNumberOfBytesToUnlockHigh : DWORD
Declare PtrSafe Function UnlockFile Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal dwFileOffsetLow As Long, _
    ByVal dwFileOffsetHigh As Long, _
    ByVal nNumberOfBytesToUnlockLow As Long, _
    ByVal nNumberOfBytesToUnlockHigh As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UnlockFile = ctypes.windll.kernel32.UnlockFile
UnlockFile.restype = wintypes.BOOL
UnlockFile.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.DWORD,  # dwFileOffsetLow : DWORD
    wintypes.DWORD,  # dwFileOffsetHigh : DWORD
    wintypes.DWORD,  # nNumberOfBytesToUnlockLow : DWORD
    wintypes.DWORD,  # nNumberOfBytesToUnlockHigh : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
UnlockFile = Fiddle::Function.new(
  lib['UnlockFile'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    -Fiddle::TYPE_INT,  # dwFileOffsetLow : DWORD
    -Fiddle::TYPE_INT,  # dwFileOffsetHigh : DWORD
    -Fiddle::TYPE_INT,  # nNumberOfBytesToUnlockLow : DWORD
    -Fiddle::TYPE_INT,  # nNumberOfBytesToUnlockHigh : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn UnlockFile(
        hFile: *mut core::ffi::c_void,  // HANDLE
        dwFileOffsetLow: u32,  // DWORD
        dwFileOffsetHigh: u32,  // DWORD
        nNumberOfBytesToUnlockLow: u32,  // DWORD
        nNumberOfBytesToUnlockHigh: u32  // DWORD
    ) -> 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 UnlockFile(IntPtr hFile, uint dwFileOffsetLow, uint dwFileOffsetHigh, uint nNumberOfBytesToUnlockLow, uint nNumberOfBytesToUnlockHigh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_UnlockFile' -Namespace Win32 -PassThru
# $api::UnlockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh)
#uselib "KERNEL32.dll"
#func global UnlockFile "UnlockFile" sptr, sptr, sptr, sptr, sptr
; UnlockFile hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; dwFileOffsetLow : DWORD -> "sptr"
; dwFileOffsetHigh : DWORD -> "sptr"
; nNumberOfBytesToUnlockLow : DWORD -> "sptr"
; nNumberOfBytesToUnlockHigh : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global UnlockFile "UnlockFile" sptr, int, int, int, int
; res = UnlockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh)
; hFile : HANDLE -> "sptr"
; dwFileOffsetLow : DWORD -> "int"
; dwFileOffsetHigh : DWORD -> "int"
; nNumberOfBytesToUnlockLow : DWORD -> "int"
; nNumberOfBytesToUnlockHigh : DWORD -> "int"
; BOOL UnlockFile(HANDLE hFile, DWORD dwFileOffsetLow, DWORD dwFileOffsetHigh, DWORD nNumberOfBytesToUnlockLow, DWORD nNumberOfBytesToUnlockHigh)
#uselib "KERNEL32.dll"
#cfunc global UnlockFile "UnlockFile" intptr, int, int, int, int
; res = UnlockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh)
; hFile : HANDLE -> "intptr"
; dwFileOffsetLow : DWORD -> "int"
; dwFileOffsetHigh : DWORD -> "int"
; nNumberOfBytesToUnlockLow : DWORD -> "int"
; nNumberOfBytesToUnlockHigh : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procUnlockFile = kernel32.NewProc("UnlockFile")
)

// hFile (HANDLE), dwFileOffsetLow (DWORD), dwFileOffsetHigh (DWORD), nNumberOfBytesToUnlockLow (DWORD), nNumberOfBytesToUnlockHigh (DWORD)
r1, _, err := procUnlockFile.Call(
	uintptr(hFile),
	uintptr(dwFileOffsetLow),
	uintptr(dwFileOffsetHigh),
	uintptr(nNumberOfBytesToUnlockLow),
	uintptr(nNumberOfBytesToUnlockHigh),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function UnlockFile(
  hFile: THandle;   // HANDLE
  dwFileOffsetLow: DWORD;   // DWORD
  dwFileOffsetHigh: DWORD;   // DWORD
  nNumberOfBytesToUnlockLow: DWORD;   // DWORD
  nNumberOfBytesToUnlockHigh: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'UnlockFile';
result := DllCall("KERNEL32\UnlockFile"
    , "Ptr", hFile   ; HANDLE
    , "UInt", dwFileOffsetLow   ; DWORD
    , "UInt", dwFileOffsetHigh   ; DWORD
    , "UInt", nNumberOfBytesToUnlockLow   ; DWORD
    , "UInt", nNumberOfBytesToUnlockHigh   ; DWORD
    , "Int")   ; return: BOOL
●UnlockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh) = DLL("KERNEL32.dll", "bool UnlockFile(void*, dword, dword, dword, dword)")
# 呼び出し: UnlockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh)
# hFile : HANDLE -> "void*"
# dwFileOffsetLow : DWORD -> "dword"
# dwFileOffsetHigh : DWORD -> "dword"
# nNumberOfBytesToUnlockLow : DWORD -> "dword"
# nNumberOfBytesToUnlockHigh : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn UnlockFile(
    hFile: ?*anyopaque, // HANDLE
    dwFileOffsetLow: u32, // DWORD
    dwFileOffsetHigh: u32, // DWORD
    nNumberOfBytesToUnlockLow: u32, // DWORD
    nNumberOfBytesToUnlockHigh: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc UnlockFile(
    hFile: pointer,  # HANDLE
    dwFileOffsetLow: uint32,  # DWORD
    dwFileOffsetHigh: uint32,  # DWORD
    nNumberOfBytesToUnlockLow: uint32,  # DWORD
    nNumberOfBytesToUnlockHigh: uint32  # DWORD
): int32 {.importc: "UnlockFile", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int UnlockFile(
    void* hFile,   // HANDLE
    uint dwFileOffsetLow,   // DWORD
    uint dwFileOffsetHigh,   // DWORD
    uint nNumberOfBytesToUnlockLow,   // DWORD
    uint nNumberOfBytesToUnlockHigh   // DWORD
);
ccall((:UnlockFile, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32, UInt32, UInt32),
      hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh)
# hFile : HANDLE -> Ptr{Cvoid}
# dwFileOffsetLow : DWORD -> UInt32
# dwFileOffsetHigh : DWORD -> UInt32
# nNumberOfBytesToUnlockLow : DWORD -> UInt32
# nNumberOfBytesToUnlockHigh : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t UnlockFile(
    void* hFile,
    uint32_t dwFileOffsetLow,
    uint32_t dwFileOffsetHigh,
    uint32_t nNumberOfBytesToUnlockLow,
    uint32_t nNumberOfBytesToUnlockHigh);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.UnlockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh)
-- hFile : HANDLE
-- dwFileOffsetLow : DWORD
-- dwFileOffsetHigh : DWORD
-- nNumberOfBytesToUnlockLow : DWORD
-- nNumberOfBytesToUnlockHigh : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const UnlockFile = lib.func('__stdcall', 'UnlockFile', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'uint32_t', 'uint32_t']);
// UnlockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh)
// hFile : HANDLE -> 'void *'
// dwFileOffsetLow : DWORD -> 'uint32_t'
// dwFileOffsetHigh : DWORD -> 'uint32_t'
// nNumberOfBytesToUnlockLow : DWORD -> 'uint32_t'
// nNumberOfBytesToUnlockHigh : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  UnlockFile: { parameters: ["pointer", "u32", "u32", "u32", "u32"], result: "i32" },
});
// lib.symbols.UnlockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh)
// hFile : HANDLE -> "pointer"
// dwFileOffsetLow : DWORD -> "u32"
// dwFileOffsetHigh : DWORD -> "u32"
// nNumberOfBytesToUnlockLow : DWORD -> "u32"
// nNumberOfBytesToUnlockHigh : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UnlockFile(
    void* hFile,
    uint32_t dwFileOffsetLow,
    uint32_t dwFileOffsetHigh,
    uint32_t nNumberOfBytesToUnlockLow,
    uint32_t nNumberOfBytesToUnlockHigh);
C, "KERNEL32.dll");
// $ffi->UnlockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToUnlockLow, nNumberOfBytesToUnlockHigh);
// hFile : HANDLE
// dwFileOffsetLow : DWORD
// dwFileOffsetHigh : DWORD
// nNumberOfBytesToUnlockLow : DWORD
// nNumberOfBytesToUnlockHigh : DWORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean UnlockFile(
        Pointer hFile,   // HANDLE
        int dwFileOffsetLow,   // DWORD
        int dwFileOffsetHigh,   // DWORD
        int nNumberOfBytesToUnlockLow,   // DWORD
        int nNumberOfBytesToUnlockHigh   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun UnlockFile = UnlockFile(
    hFile : Void*,   # HANDLE
    dwFileOffsetLow : UInt32,   # DWORD
    dwFileOffsetHigh : UInt32,   # DWORD
    nNumberOfBytesToUnlockLow : UInt32,   # DWORD
    nNumberOfBytesToUnlockHigh : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef UnlockFileNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Uint32, Uint32);
typedef UnlockFileDart = int Function(Pointer<Void>, int, int, int, int);
final UnlockFile = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<UnlockFileNative, UnlockFileDart>('UnlockFile');
// hFile : HANDLE -> Pointer<Void>
// dwFileOffsetLow : DWORD -> Uint32
// dwFileOffsetHigh : DWORD -> Uint32
// nNumberOfBytesToUnlockLow : DWORD -> Uint32
// nNumberOfBytesToUnlockHigh : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UnlockFile(
  hFile: THandle;   // HANDLE
  dwFileOffsetLow: DWORD;   // DWORD
  dwFileOffsetHigh: DWORD;   // DWORD
  nNumberOfBytesToUnlockLow: DWORD;   // DWORD
  nNumberOfBytesToUnlockHigh: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'UnlockFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UnlockFile"
  c_UnlockFile :: Ptr () -> Word32 -> Word32 -> Word32 -> Word32 -> IO CInt
-- hFile : HANDLE -> Ptr ()
-- dwFileOffsetLow : DWORD -> Word32
-- dwFileOffsetHigh : DWORD -> Word32
-- nNumberOfBytesToUnlockLow : DWORD -> Word32
-- nNumberOfBytesToUnlockHigh : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let unlockfile =
  foreign "UnlockFile"
    ((ptr void) @-> uint32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* dwFileOffsetLow : DWORD -> uint32_t *)
(* dwFileOffsetHigh : DWORD -> uint32_t *)
(* nNumberOfBytesToUnlockLow : DWORD -> uint32_t *)
(* nNumberOfBytesToUnlockHigh : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("UnlockFile" unlock-file :convention :stdcall) :int32
  (h-file :pointer)   ; HANDLE
  (dw-file-offset-low :uint32)   ; DWORD
  (dw-file-offset-high :uint32)   ; DWORD
  (n-number-of-bytes-to-unlock-low :uint32)   ; DWORD
  (n-number-of-bytes-to-unlock-high :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UnlockFile = Win32::API::More->new('KERNEL32',
    'BOOL UnlockFile(HANDLE hFile, DWORD dwFileOffsetLow, DWORD dwFileOffsetHigh, DWORD nNumberOfBytesToUnlockLow, DWORD nNumberOfBytesToUnlockHigh)');
# my $ret = $UnlockFile->Call($hFile, $dwFileOffsetLow, $dwFileOffsetHigh, $nNumberOfBytesToUnlockLow, $nNumberOfBytesToUnlockHigh);
# hFile : HANDLE -> HANDLE
# dwFileOffsetLow : DWORD -> DWORD
# dwFileOffsetHigh : DWORD -> DWORD
# nNumberOfBytesToUnlockLow : DWORD -> DWORD
# nNumberOfBytesToUnlockHigh : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目