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

LockFileEx

関数
ファイルの指定範囲を共有または排他ロックする。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL LockFileEx(
    HANDLE hFile,
    LOCK_FILE_FLAGS dwFlags,
    DWORD dwReserved,   // optional
    DWORD nNumberOfBytesToLockLow,
    DWORD nNumberOfBytesToLockHigh,
    OVERLAPPED* lpOverlapped
);

パラメーター

名前方向
hFileHANDLEin
dwFlagsLOCK_FILE_FLAGSin
dwReservedDWORDoptional
nNumberOfBytesToLockLowDWORDin
nNumberOfBytesToLockHighDWORDin
lpOverlappedOVERLAPPED*inout

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL LockFileEx(
    HANDLE hFile,
    LOCK_FILE_FLAGS dwFlags,
    DWORD dwReserved,   // optional
    DWORD nNumberOfBytesToLockLow,
    DWORD nNumberOfBytesToLockHigh,
    OVERLAPPED* lpOverlapped
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool LockFileEx(
    IntPtr hFile,   // HANDLE
    uint dwFlags,   // LOCK_FILE_FLAGS
    uint dwReserved,   // DWORD optional
    uint nNumberOfBytesToLockLow,   // DWORD
    uint nNumberOfBytesToLockHigh,   // DWORD
    IntPtr lpOverlapped   // OVERLAPPED* in/out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LockFileEx(
    hFile As IntPtr,   ' HANDLE
    dwFlags As UInteger,   ' LOCK_FILE_FLAGS
    dwReserved As UInteger,   ' DWORD optional
    nNumberOfBytesToLockLow As UInteger,   ' DWORD
    nNumberOfBytesToLockHigh As UInteger,   ' DWORD
    lpOverlapped As IntPtr   ' OVERLAPPED* in/out
) As Boolean
End Function
' hFile : HANDLE
' dwFlags : LOCK_FILE_FLAGS
' dwReserved : DWORD optional
' nNumberOfBytesToLockLow : DWORD
' nNumberOfBytesToLockHigh : DWORD
' lpOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function LockFileEx Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal dwReserved As Long, _
    ByVal nNumberOfBytesToLockLow As Long, _
    ByVal nNumberOfBytesToLockHigh 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

LockFileEx = ctypes.windll.kernel32.LockFileEx
LockFileEx.restype = wintypes.BOOL
LockFileEx.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    wintypes.DWORD,  # dwFlags : LOCK_FILE_FLAGS
    wintypes.DWORD,  # dwReserved : DWORD optional
    wintypes.DWORD,  # nNumberOfBytesToLockLow : DWORD
    wintypes.DWORD,  # nNumberOfBytesToLockHigh : 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')
LockFileEx = Fiddle::Function.new(
  lib['LockFileEx'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : LOCK_FILE_FLAGS
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
    -Fiddle::TYPE_INT,  # nNumberOfBytesToLockLow : DWORD
    -Fiddle::TYPE_INT,  # nNumberOfBytesToLockHigh : DWORD
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn LockFileEx(
        hFile: *mut core::ffi::c_void,  // HANDLE
        dwFlags: u32,  // LOCK_FILE_FLAGS
        dwReserved: u32,  // DWORD optional
        nNumberOfBytesToLockLow: u32,  // DWORD
        nNumberOfBytesToLockHigh: 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 LockFileEx(IntPtr hFile, uint dwFlags, uint dwReserved, uint nNumberOfBytesToLockLow, uint nNumberOfBytesToLockHigh, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LockFileEx' -Namespace Win32 -PassThru
# $api::LockFileEx(hFile, dwFlags, dwReserved, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh, lpOverlapped)
#uselib "KERNEL32.dll"
#func global LockFileEx "LockFileEx" sptr, sptr, sptr, sptr, sptr, sptr
; LockFileEx hFile, dwFlags, dwReserved, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh, varptr(lpOverlapped)   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; dwFlags : LOCK_FILE_FLAGS -> "sptr"
; dwReserved : DWORD optional -> "sptr"
; nNumberOfBytesToLockLow : DWORD -> "sptr"
; nNumberOfBytesToLockHigh : DWORD -> "sptr"
; lpOverlapped : OVERLAPPED* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global LockFileEx "LockFileEx" sptr, int, int, int, int, var
; res = LockFileEx(hFile, dwFlags, dwReserved, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh, lpOverlapped)
; hFile : HANDLE -> "sptr"
; dwFlags : LOCK_FILE_FLAGS -> "int"
; dwReserved : DWORD optional -> "int"
; nNumberOfBytesToLockLow : DWORD -> "int"
; nNumberOfBytesToLockHigh : DWORD -> "int"
; lpOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL LockFileEx(HANDLE hFile, LOCK_FILE_FLAGS dwFlags, DWORD dwReserved, DWORD nNumberOfBytesToLockLow, DWORD nNumberOfBytesToLockHigh, OVERLAPPED* lpOverlapped)
#uselib "KERNEL32.dll"
#cfunc global LockFileEx "LockFileEx" intptr, int, int, int, int, var
; res = LockFileEx(hFile, dwFlags, dwReserved, nNumberOfBytesToLockLow, nNumberOfBytesToLockHigh, lpOverlapped)
; hFile : HANDLE -> "intptr"
; dwFlags : LOCK_FILE_FLAGS -> "int"
; dwReserved : DWORD optional -> "int"
; nNumberOfBytesToLockLow : DWORD -> "int"
; nNumberOfBytesToLockHigh : DWORD -> "int"
; lpOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLockFileEx = kernel32.NewProc("LockFileEx")
)

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