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

LockFile

関数
ファイルの指定範囲をロックして排他制御する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL LockFile(
    HANDLE hFile,
    DWORD dwFileOffsetLow,
    DWORD dwFileOffsetHigh,
    DWORD nNumberOfBytesToLockLow,
    DWORD nNumberOfBytesToLockHigh
);

パラメーター

名前型方向説明
hFileHANDLEinファイルへのハンドル。このファイルハンドルは、GENERIC_READ または GENERIC_WRITE アクセス権を指定して作成されている必要があります。詳細については、 File Security and Access Rights を参照してください。
dwFileOffsetLowDWORDinロックを開始するファイル内の開始バイトオフセットの下位 32 ビット。
dwFileOffsetHighDWORDinロックを開始するファイル内の開始バイトオフセットの上位 32 ビット。
nNumberOfBytesToLockLowDWORDinロックするバイト範囲の長さの下位 32 ビット。
nNumberOfBytesToLockHighDWORDinロックするバイト範囲の長さの上位 32 ビット。

戻り値の型: BOOL

公式ドキュメント

指定したファイルを、呼び出し元プロセスによる排他アクセス用にロックします。

戻り値

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

関数が失敗した場合、戻り値は 0（FALSE）です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

LockFile の呼び出しが同期的に完了する場合、ファイルハンドルに完了ポートが関連付けられていても、完了エントリがキューに登録されないことがあります。

UnlockFile 関数は、 LockFile によってロックされたファイル領域のロックを解除します。

ファイルの領域をロックすると、ロックを行ったプロセスのスレッドは、このファイルハンドルを使用して指定領域への排他アクセスを得ます。ロックを行ったプロセスが作成した子プロセスがこのファイルハンドルを継承しても、子プロセスにはロックされた領域へのアクセスは許可されません。ロックを行ったプロセスがそのファイルを 2 回目に開いた場合、その領域のロックを解除するまで、2 つ目のハンドルを通じて指定領域にアクセスすることはできません。

ファイルの領域をロックしても、マップされたファイルビューからの読み取りや書き込みは妨げられません。

現在のファイルの末尾を超えるバイトをロックすることができます。これは、ファイルの末尾にレコードを追加する処理を調整する際に役立ちます。

排他ロックは、ファイルの既存のロック領域と重複させることはできません。詳細については、LockFileEx を参照してください。

LockFile がファイルの領域をロックできない場合、即座に 0 を返します。ブロックはしません。ロックが取得されるまでブロックするファイルロック要求を発行するには、LOCKFILE_FAIL_IMMEDIATELY フラグを指定せずに LockFileEx を使用します。

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

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

テクノロジ サポート状況
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 透過的フェールオーバー (TFO) はい
SMB 3.0 とスケールアウトファイル共有 (SO) はい
クラスター共有ボリュームファイルシステム (CsvFS) はい
回復性ファイルシステム (ReFS) はい

例

例については、 Appending One File to Another File を参照してください。

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLockFile = kernel32.NewProc("LockFile")
)

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

extern "kernel32" fn LockFile(
    hFile: ?*anyopaque, // HANDLE
    dwFileOffsetLow: u32, // DWORD
    dwFileOffsetHigh: u32, // DWORD
    nNumberOfBytesToLockLow: u32, // DWORD
    nNumberOfBytesToLockHigh: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc LockFile(
    hFile: pointer,  # HANDLE
    dwFileOffsetLow: uint32,  # DWORD
    dwFileOffsetHigh: uint32,  # DWORD
    nNumberOfBytesToLockLow: uint32,  # DWORD
    nNumberOfBytesToLockHigh: uint32  # DWORD
): int32 {.importc: "LockFile", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int LockFile(
    void* hFile,   // HANDLE
    uint dwFileOffsetLow,   // DWORD
    uint dwFileOffsetHigh,   // DWORD
    uint nNumberOfBytesToLockLow,   // DWORD
    uint nNumberOfBytesToLockHigh   // DWORD
);
ccall((:LockFile, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32, UInt32, UInt32),
      hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh)
# hFile : HANDLE -> Ptr{Cvoid}
# dwFileOffsetLow : DWORD -> UInt32
# dwFileOffsetHigh : DWORD -> UInt32
# nNumberOfBytesToLockLow : DWORD -> UInt32
# nNumberOfBytesToLockHigh : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t LockFile(
    void* hFile,
    uint32_t dwFileOffsetLow,
    uint32_t dwFileOffsetHigh,
    uint32_t nNumberOfBytesToLockLow,
    uint32_t nNumberOfBytesToLockHigh);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.LockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh)
-- hFile : HANDLE
-- dwFileOffsetLow : DWORD
-- dwFileOffsetHigh : DWORD
-- nNumberOfBytesToLockLow : DWORD
-- nNumberOfBytesToLockHigh : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const LockFile = lib.func('__stdcall', 'LockFile', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'uint32_t', 'uint32_t']);
// LockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh)
// hFile : HANDLE -> 'void *'
// dwFileOffsetLow : DWORD -> 'uint32_t'
// dwFileOffsetHigh : DWORD -> 'uint32_t'
// nNumberOfBytesToLockLow : DWORD -> 'uint32_t'
// nNumberOfBytesToLockHigh : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  LockFile: { parameters: ["pointer", "u32", "u32", "u32", "u32"], result: "i32" },
});
// lib.symbols.LockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh)
// hFile : HANDLE -> "pointer"
// dwFileOffsetLow : DWORD -> "u32"
// dwFileOffsetHigh : DWORD -> "u32"
// nNumberOfBytesToLockLow : DWORD -> "u32"
// nNumberOfBytesToLockHigh : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t LockFile(
    void* hFile,
    uint32_t dwFileOffsetLow,
    uint32_t dwFileOffsetHigh,
    uint32_t nNumberOfBytesToLockLow,
    uint32_t nNumberOfBytesToLockHigh);
C, "KERNEL32.dll");
// $ffi->LockFile(hFile, dwFileOffsetLow, dwFileOffsetHigh, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh);
// hFile : HANDLE
// dwFileOffsetLow : DWORD
// dwFileOffsetHigh : DWORD
// nNumberOfBytesToLockLow : DWORD
// nNumberOfBytesToLockHigh : 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 LockFile(
        Pointer hFile,   // HANDLE
        int dwFileOffsetLow,   // DWORD
        int dwFileOffsetHigh,   // DWORD
        int nNumberOfBytesToLockLow,   // DWORD
        int nNumberOfBytesToLockHigh   // DWORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun LockFile = LockFile(
    hFile : Void*,   # HANDLE
    dwFileOffsetLow : UInt32,   # DWORD
    dwFileOffsetHigh : UInt32,   # DWORD
    nNumberOfBytesToLockLow : UInt32,   # DWORD
    nNumberOfBytesToLockHigh : 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 LockFileNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Uint32, Uint32);
typedef LockFileDart = int Function(Pointer<Void>, int, int, int, int);
final LockFile = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<LockFileNative, LockFileDart>('LockFile');
// hFile : HANDLE -> Pointer<Void>
// dwFileOffsetLow : DWORD -> Uint32
// dwFileOffsetHigh : DWORD -> Uint32
// nNumberOfBytesToLockLow : DWORD -> Uint32
// nNumberOfBytesToLockHigh : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LockFile(
  hFile: THandle;   // HANDLE
  dwFileOffsetLow: DWORD;   // DWORD
  dwFileOffsetHigh: DWORD;   // DWORD
  nNumberOfBytesToLockLow: DWORD;   // DWORD
  nNumberOfBytesToLockHigh: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'LockFile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let lockfile =
  foreign "LockFile"
    ((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 *)
(* nNumberOfBytesToLockLow : DWORD -> uint32_t *)
(* nNumberOfBytesToLockHigh : 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 ("LockFile" lock-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-lock-low :uint32)   ; DWORD
  (n-number-of-bytes-to-lock-high :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LockFile = Win32::API::More->new('KERNEL32',
    'BOOL LockFile(HANDLE hFile, DWORD dwFileOffsetLow, DWORD dwFileOffsetHigh, DWORD nNumberOfBytesToLockLow, DWORD nNumberOfBytesToLockHigh)');
# my $ret = $LockFile->Call($hFile, $dwFileOffsetLow, $dwFileOffsetHigh, $nNumberOfBytesToLockLow, $nNumberOfBytesToLockHigh);
# hFile : HANDLE -> HANDLE
# dwFileOffsetLow : DWORD -> DWORD
# dwFileOffsetHigh : DWORD -> DWORD
# nNumberOfBytesToLockLow : DWORD -> DWORD
# nNumberOfBytesToLockHigh : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目